whatsapp-api-js - v6.3.0
    Preparing search index...

    Type Alias ServerSystemMessage

    type ServerSystemMessage = {
        system: {
            body: string;
            customer?: string;
            identity?: string;
            new_wa_id?: number | string;
            parent_user_id?: string;
            previous_parent_user_id?: string;
            previous_user_id: string;
            type:
                | "customer_changed_number"
                | "customer_identity_changed"
                | "user_changed_user_id"
                | "user_changed_number"
                | string;
            user_id: string;
            wa_id?: string;
        };
        type: "system";
    }
    Index
    system type
    system: {
        body: string;
        customer?: string;
        identity?: string;
        new_wa_id?: number | string;
        parent_user_id?: string;
        previous_parent_user_id?: string;
        previous_user_id: string;
        type:
            | "customer_changed_number"
            | "customer_identity_changed"
            | "user_changed_user_id"
            | "user_changed_number"
            | string;
        user_id: string;
        wa_id?: string;
    }

    Type Declaration

    • body: string
    • Optionalcustomer?: string
    • Optionalidentity?: string
    • Optionalnew_wa_id?: number | string

      Since v12.0 it is undefined, use wa_id instead.

      I'm actually stunned this exists, since I started the library with v13 or 14.

    • Optionalparent_user_id?: string

      Will be set to the user’s new parent BSUID, if you have enabled parent BSUIDs

      https://developers.facebook.com/documentation/business-messaging/whatsapp/business-scoped-user-ids#parent-business-scoped-user-ids

    • Optionalprevious_parent_user_id?: string

      Will be set to the parent BSUID the user had before the change, if you have enabled parent BSUIDs

    • previous_user_id: string

      Will be set to the BSUID the user had before the change

    • type:
          | "customer_changed_number"
          | "customer_identity_changed"
          | "user_changed_user_id"
          | "user_changed_number"
          | string
    • user_id: string

      Will be set to the user’s new BSUID

    • Optionalwa_id?: string

      Will be omitted if the user has enabled the username feature Will be set to the user’s phone number if the user has not enabled the usernames feature

    type: "system"

    Settings
    Member Visibility

    On This Page
    Properties