WhatsApp
List WhatsApp numbers
The WhatsApp numbers your API key can see, oldest first. Use it to find a number id, then pass that id to the other routes. Each number carries capabilities, which says what it can send. Archived numbers are left out.
Set up WhatsApp first. Connect a WhatsApp number in the dashboard or with Connect numbers. Included on every paid plan. See plans.
GET
Bearersession
Query parameters
limitintegerRows per page.
cursorstringThe next_cursor from the previous page. Omit it on the first request and pass it back unchanged.
curl -X GET 'https://omnidim.io/api/v1/whatsapp/numbers?limit=20' \ -H 'Authorization: Bearer YOUR_API_KEY'
Example response
synthetic
{ "data": [ { "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 } } ], "has_more": false, "next_cursor": "string" }
BearerAuthheader
AuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
limit?integerRows per page.
Range
1 <= value <= 100Default
20cursor?stringThe next_cursor from the previous page. Omit it on the first request and pass it back unchanged.
Response body
application/jsonOne page of numbers.
application/jsondata?has_more?booleannext_cursor?string