WhatsApp Numbers

Get a WhatsApp number

Changed on

Retrieves one connected WhatsApp number by SignalWire ID so you can inspect how it is used for outbound and inbound communication. Use List WhatsApp numbers to discover IDs. Standard SMS and MMS phone numbers use Get phone number.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

get/api/messaging/whatsapp/numbers/{id}

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/messaging/whatsapp/numbers/{id}
  • Auth
    HTTP basic

Path parameters

idstring uuid required

Universal Unique Identifier.

The SignalWire identifier of the WhatsApp number.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

business_phone_number_idstring required

The Meta phone number ID for this WhatsApp number.

phone_numberstring required

The WhatsApp number, prefixed with whatsapp:. Use this value as the from address when sending messages.

calling_handler_resource_idstring uuid required

Universal Unique Identifier.

messaging_handler_resource_idstring uuid required

Universal Unique Identifier.

business_namestring nullable required

The business name as registered with Meta.

waba_idstring required

The WhatsApp Business Account ID (WABA ID) assigned by Meta.

whatsapp_business_idstring uuid required

Universal Unique Identifier.

voice_enabledboolean required

Whether calling is enabled for this number. Turn it on from the SIP Calling column of the WhatsApp Numbers tab in your Dashboard, as described in Enable voice on a WhatsApp number.

voice_capableboolean required

Whether this number can receive calls — true when voice_enabled is true and a calling handler is attached. See Receive WhatsApp calls.

created_atstring required

The date and time when the record was created.

updated_atstring required

The date and time when the record was last updated.

Example response

{
  "business_phone_number_id": "102290129340398",
  "phone_number": "whatsapp:+15557654321",
  "business_name": "Acme, Inc.",
  "waba_id": "109876543210987",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Changes

Some revisions have not been checked yet.