Skip to navigation
MessagingWhatsApp

Get a WhatsApp number

View as MarkdownOpen in Claude

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.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Path parameters

idstringRequiredformat: "uuid"
The SignalWire identifier of the WhatsApp number.

Response

The request has succeeded.
idstringformat: "uuid"
The SignalWire identifier of the WhatsApp number.
business_phone_number_idstring
The Meta phone number ID for this WhatsApp number.
phone_numberstring

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

calling_handler_resource_idstring or nullformat: "uuid"

The ID of the resource (Call Flow, AI Agent, SWML script, etc.) that handles inbound calls to this number. Null if no calling handler is configured.

messaging_handler_resource_idstring or nullformat: "uuid"
The ID of the resource that handles inbound messages to this number. Null if no messaging handler is configured.
business_namestring or null
The business name as registered with Meta.
waba_idstring

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

whatsapp_business_idstringformat: "uuid"
The SignalWire identifier of the WhatsApp Business Account this number belongs to.
voice_enabledboolean

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

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

created_atstring
The date and time when the record was created.
updated_atstring
The date and time when the record was last updated.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error