Sign in

v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
Phone Numbers

List phone numbers

List all phone numbers purchased by the authenticated user. By default, released numbers are excluded. Connected (bring-your-own) WhatsApp numbers are returned in the separate connected array; they are not billed and have no provisioning lifecycle.

get/v1/phone-numbers

Query parameters

status'provisioning' | 'verifying' | 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'active' | 'suspended' | 'releasing' | 'released'

Filter by status (by default excludes released numbers). NOTE: status=pending_regulatory returns the "provisioning" view — numbers still in review PLUS recently-declined (last 30 days) ones, so a failed registration surfaces (with regulatoryDeclineReason) instead of silently disappearing. Declined numbers can be re-submitted via POST /v1/phone-numbers/{id}/remediate. verifying is the short-lived state after the number is provisioned on our side while WhatsApp confirms the activation code; the number is not billed until it reaches active.

profileIdstring

Filter by profile

Response

Phone numbers retrieved successfully

Example response

{
  "sandbox": {
    "phoneNumber": "+12029087457",
    "template": {
      "name": "sandbox_start",
      "language": "en"
    }
  }
}