ApiNumbers

Get WhatsApp calling status

GET
/numbers/{id}/whatsapp

Whether WhatsApp calling is set up on this number, and if so, its status. The SIP password is never returned. See the WhatsApp calling guide.

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard.

In: header

Path Parameters

id*string

Phone number UUID

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/numbers/497f6eca-6276-4993-bfeb-53cbbbba6f08/whatsapp"

{
  "status": "active",
  "error_code": null,
  "sip_username": "31850835037",
  "updated_at": "2026-10-15T12:00:00Z"
}

{
  "error": "Invalid API key",
  "message": "string"
}
{
  "error": "number_not_found",
  "message": "No number with this ID in your organization."
}