List WhatsApp numbers

GET

https://{your_space_name}.signalwire.com/api/messaging/whatsapp/numbers

GET

/api/messaging/whatsapp/numbers

$ curl https://{your_space_name}.signalwire.com/api/messaging/whatsapp/numbers \
>      -u "<project_id>:<api_token>"

1 {
2   "data": [
3     {
4       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5       "business_phone_number_id": "102290129340398",
6       "phone_number": "whatsapp:+15557654321",
7       "calling_handler_resource_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
8       "messaging_handler_resource_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
9       "business_name": "Acme, Inc.",
10       "waba_id": "109876543210987",
11       "whatsapp_business_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
12       "voice_enabled": false,
13       "voice_capable": false,
14       "created_at": "2024-01-15T10:30:00Z",
15       "updated_at": "2024-01-15T10:30:00Z"
16     }
17   ]
18 }

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.

Returns the WhatsApp numbers connected to your Space. Each record includes its association with a WhatsApp Business Account, voice-capability flags, and the resource IDs used for routing calls or messages. Use `phone_number` (prefixed with `whatsapp:`) as the `from` address when [sending messages](/docs/platform/messaging/whatsapp/send-messages). #### 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](/docs/platform/your-signalwire-api-space).

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)

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) ```

Response

The request has succeeded.

datalist of objects

List of WhatsApp numbers available to the Space.

Errors

401

Unauthorized Error

500

Internal Server Error