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

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.

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

POST/whatsapp/numbers/preview
Body
2 fields
·

Your WhatsApp Business Account id, from WhatsApp Manager.

A Meta access token that never expires, with both WhatsApp permissions.

curl -X POST 'https://omnidim.io/api/v1/whatsapp/numbers/preview' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example response
synthetic
{
  "data": [
    {
      "phone_number_id": "string",
      "display_phone_number": "+1 555-123-4567",
      "name": "string",
      "status": "string",
      "can_send_message": "string",
      "quality_rating": "string",
      "name_status": "string",
      "code_verification_status": "string",
      "platform_type": "string",
      "is_on_biz_app": false,
      "needs_migration": false,
      "needs_registration": false,
      "reason": "string",
      "already_imported": false,
      "connected_elsewhere": false
    }
  ]
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

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

Request Body

application/json
waba_id*string

Your WhatsApp Business Account id, from WhatsApp Manager.

access_token*string

A Meta access token that never expires, with both WhatsApp permissions.

Response body

application/json

Response Body

The numbers on the account.

application/json
data?

Connect WhatsApp numbers

Connects numbers from your own WhatsApp Business Account with your Meta access token. List them first with [Preview numbers](/docs/api-reference/whatsapp/previewWhatsappNumbers), then pass the ids you want.

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.