1. References
  2. Management API
  3. WABPhoneNumbers
Rate this page:

WABPhoneNumbers

Methods

AddWABPhoneNumber

Copy URL

Adds a new WhatsApp Business phone number.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Accountant
AddWABPhoneNumber example
Copy

AddWABPhoneNumber example

Adds a new WhatsApp Business phone number.

Parameters

  • application_id:

    number

    Optional

    Bound application ID

  • application_name:

    string

    Optional

    Bound application name that can be used instead of application_id

  • description:

    string

    Optional

    WhatsApp Business phone number description

  • rule_id:

    number

    Optional

    Bound rule ID

  • rule_name:

    string

    Optional

    Bound rule name that can be used instead of rule_id

  • voice_password:

    string

    WhatsApp Business SIP password

  • wab_phone_number:

    string

    WhatsApp Business phone number

Returns

  • result:

    number

    1

DeleteWABPhoneNumber

Copy URL

Deletes a WhatsApp Business phone number.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
DeleteWABPhoneNumber example
Copy

DeleteWABPhoneNumber example

Deletes a WhatsApp Business phone number.

Parameters

  • wab_phone_number:

    string

    WhatsApp Business phone number to delete

Returns

  • result:

    number

    1

GetWABPhoneNumbers

Copy URL

Gets the account's WhatsApp Business phone numbers.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
Supervisor
Accountant
Support
Payer
GetWABPhoneNumbers example
Copy

GetWABPhoneNumbers example

Parameters

  • application_id:

    number

    Optional

    Application ID that is bound to the WhatsApp Business phone number

  • application_name:

    string

    Optional

    Bound application name that can be used instead of application_id

  • count:

    number

    Optional
    Defaults on:  100

    Maximum returning records count

  • country_code:

    string

    Optional

    Country code filter (2 symbols) for the WhatsApp Business phone number

  • offset:

    number

    Optional
    Defaults on:  0

    Number of records to be skipped in the result

  • wab_phone_number:

    string

    Optional

    WhatsApp Business phone number

Returns

  • count:

    number

    Number of returned records

  • result:

    [WABPhoneInfoType]

    WhatsApp Business phone numbers info

  • total_count:

    number

    Number of total records found

SetWABPhoneNumberInfo

Copy URL

Sets details for the specified WhatsApp Business phone number.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Accountant
SetWABPhoneNumberInfo example
Copy

SetWABPhoneNumberInfo example

Parameters

  • application_id:

    number

    Optional

    Bound application ID

  • application_name:

    string

    Optional

    Bound application name that can be used instead of application_id

  • description:

    string

    Optional

    New WhatsApp Business phone number description

  • rule_id:

    number

    Optional

    Bound rule ID

  • rule_name:

    string

    Optional

    Bound rule name that can be used instead of rule_id

  • voice_password:

    string

    Optional

    New WhatsApp Business SIP password

  • wab_phone_number:

    string

    WhatsApp Business phone number to change details for

Returns

  • result:

    number

    1