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

Turn calling on or off

Turn calling on or off for a Meta Cloud number. A customer calls this number; it does not place calls. Turning it on requires every blocking check to pass, or the request answers 409. Turning it off is always allowed.

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

PATCH/whatsapp/numbers//calling
Path parameters
number_idrequired
Body

true to turn calling on, false to turn it off.

curl -X PATCH 'https://backend.omnidim.io/api/v1/whatsapp/numbers/{number_id}/calling' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "enabled": true
}'
Example response
synthetic
{
  "message": "Calling turned on.",
  "status": "enabled",
  "checks": [
    {
      "code": "string",
      "ok": false,
      "blocking": false,
      "title": "string",
      "fix": "string",
      "doc_url": "string"
    }
  ]
}

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.

Request Body

application/json
enabled*boolean

true to turn calling on, false to turn it off.

Response body

application/json

Response Body

The new calling state.

application/json
message?string
status?string
Value in"enabled""disabled"
checks?

Get calling settings

Whether calling is on for this number and whether it can be turned on, with the list of checks. A failing check does not fail the request: the response stays 200 and names the check that blocks. Meta Cloud numbers only. Calling must be included in your plan.

List conversations

A number's inbox, newest activity first. Poll it with updated_since for changes since your last call, or page it with cursor. There are no event webhooks, so polling is how an integration learns about new messages.