MCP is live.Set upAsk the community
OmniDimension
Dashboard
DocumentationAPI referenceSDKsMCP
WhatsApp

Get a WhatsApp number

One number, with its status, quality and messaging limit, and what it can send. A number in another workspace answers 404.

Set up WhatsApp first. Connect a WhatsApp number in the dashboard or with Connect numbers. Included on every paid plan. See plans.

GET/whatsapp/numbers/
Path parameters
number_idrequired
curl -X GET 'https://backend.omnidim.io/api/v1/whatsapp/numbers/{number_id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
synthetic
{
  "id": 412,
  "phone_number": "+15551234567",
  "provider": "meta",
  "name": "string",
  "status": "active",
  "account_restriction": "string",
  "agent_id": 0,
  "quality_rating": "string",
  "messaging_limit": "string",
  "capabilities": {
    "types": [
      "text"
    ],
    "reply_to": false,
    "window_enforced": false,
    "delivery_status": "push",
    "template_sync": false
  }
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Path Parameters

number_id*integer

Id of a WhatsApp number in your workspace, from listWhatsappNumbers. A number in another workspace answers 404.

Response body

application/json

Response Body

The number.

application/json
id?integer
phone_number?string
provider?string

Who carries the number. meta is the WhatsApp Cloud API.

Value in"meta""twilio""sensibot""interakt"
name?string

The label you gave the number.

status?string

active can send. restricted is limited by WhatsApp. disconnected is missing its credentials, so it cannot send.

Value in"active""restricted""disconnected"
account_restriction?string

WhatsApp's own restriction on the account, when there is one.

agent_id?integer

The agent that answers this number, when one is attached.

quality_rating?string

WhatsApp's quality rating. Meta numbers only.

messaging_limit?string

How many customers you can start chats with in 24 hours. Meta numbers only.

capabilities?

What this number can send, and how its delivery status is learned.

Preview numbers to connect

Lists the numbers on your WhatsApp Business Account with their health, and connects nothing. The access token is checked first, against the same rules as connecting, so a preview that passes can connect.

List templates

The number's message templates, as last synced, oldest first. Pass status=approved to see exactly the templates a send accepts. Sync the list with syncWhatsappTemplates first if a template you expect is missing.