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.
Set up WhatsApp first. Connect a WhatsApp number in the dashboard or with Connect numbers. Included on every paid plan. See plans.
number_idrequiredcurl -X GET 'https://backend.omnidim.io/api/v1/whatsapp/numbers/{number_id}/calling' \ -H 'Authorization: Bearer YOUR_API_KEY'
{ "available": false, "status": "enabled", "can_enable": false, "checks": [ { "code": "string", "ok": false, "blocking": false, "title": "string", "fix": "string", "doc_url": "string" } ], "checked_at": "string" }
BearerAuthAuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
number_id*integerId of a WhatsApp number in your workspace, from
listWhatsappNumbers.
A number in another workspace answers 404.
Response body
application/jsonThe calling state and checks.
application/jsonWhether calling is on for this number, and whether it can be turned on.
available?booleanCalling is included in your plan and your role.
status?string"enabled""disabled""not_set"can_enable?booleanEvery blocking check passes, so calling can be turned on now.
checks?checked_at?stringSync templates
Pull the number's templates and their review statuses from WhatsApp into your list. Run it after you create or edit a template in Meta. It runs at most once a minute per number: a second call inside that minute answers 429.
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.
