GET/v1/whatsapp/numbers
WhatsApp Calling
List WhatsApp Numbers
Returns every connected WhatsApp Business number on the account with its id, calling status, assigned assistant, and call permission template. Use it to find the whatsapp_number or whatsapp_account_id to pass to Initiate WhatsApp Call.
Request
Endpoint
GET
/v1/whatsapp/numbersAuthentication
x-api-keyorAuthorization: BearerNotes
can_call is true when the number is active (connected with an assistant assigned) and calling is switched on at Meta.
A number without a permission_template can only call people who have already allowed calls from it.
Disconnected numbers are not listed.
Response Example
response.json
{
"success": true,
"data": [
{
"id": "6700a1b2c3d4e5f6a7b8c9d0",
"whatsapp_number": "+91 80000 12345",
"verified_name": "Skyline Properties",
"status": "active",
"calling_enabled": true,
"assistant_id": "66aa2b3c4d5e6f7a8b9c0d11",
"permission_template": {
"name": "call_permission_request",
"language": "en"
},
"can_call": true
}
]
}Status Codes
| HTTP | Meaning | Description |
|---|---|---|
| 200 | OK | Request succeeded. |
| 401 | Unauthorized | Missing, invalid, inactive, or origin-restricted API key. |
| 403 | Forbidden | WhatsApp calling is not enabled for this account. |
| 429 | Rate limited | Per-IP or per-key request budget was exceeded. |
Security Model
User-scoped by default
This endpoint only sees resources owned by the user attached to the API key. If another user's id is supplied, the API responds as if the resource does not exist.