Calls
Dispatch call
Initiate a call to a phone number using a specified agent. The phone number must include a country code with a leading plus.
POST/calls/dispatch
Bearersession
Body
4 fields
·
The ID of the agent that will handle the call.
The phone number to call. Must include country code (e.g., +15551234567).
The imported phone number id to call.
Optional context information as key-value pairs to be passed to the agent during the call. Can contain any custom fields relevant to your use case.
curl -X POST 'https://backend.omnidim.io/api/v1/calls/dispatch' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "agent_id": 158910, "to_number": "+15551234567", "from_number_id": 23, "call_context": { "user_name": "Jane Doe", "account_id": "A-2031", "last_order": "2026-04-15" } }'
Example response
{ "success": true, "status": "dispatched", "requestId": 3166940, "custom_variables_count": 1 }
Authorization
BearerAuth AuthorizationBearer <token>
Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json