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.
Reseller keys only: act as one of your clients by its user id. Omit it to act on your own account. [How acting for a client works](/docs/reseller/your-clients/acting-as-clients).
The ID of the agent that will handle the call.
The phone number to call. Must include country code (e.g., +15551234567).
Id of a phone number on your account to place the call from (see the phone number list endpoint). Omit to use the platform's default number.
curl -X POST 'https://omnidim.io/api/v1/calls/dispatch' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "user_id": 1234, "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" }, "metadata": { "crm_lead_id": "lead_9876", "source": "website_form" }, "__languages": [ "Tamil", "English" ], "__post_call_actions": { "email": { "recipients": [ "support@example.com" ], "extracted_variables": [ { "key": "customer_issue", "prompt": "Identify the main issue the customer is experiencing." } ], "trigger_call_statuses": [ "completed", "voicemail_detected" ] }, "webhook": { "url": "https://your-webhook-endpoint.com/omnidim-callback", "extracted_variables": [ { "key": "customer_issue", "prompt": "Identify the main issue the customer is experiencing." } ], "trigger_call_statuses": [ "completed", "failed" ] }, "omni_crm": { "extracted_variables": [ { "key": "customer_issue", "prompt": "Identify the main issue the customer is experiencing." } ] }, "cloud_whatsapp": { "extracted_variables": [ { "key": "customer_issue", "prompt": "Identify the main issue the customer is experiencing." } ], "template_variables": [ { "index": "1", "extracted_var": "customer_name" } ], "templates": [ { "usage_description": "Send when the caller books an appointment.", "variable_mappings": [ { "index": "1" } ] } ] }, "workflow": { "extracted_variables": [ { "key": "customer_issue", "prompt": "Identify the main issue the customer is experiencing." } ] }, "google_sheets": { "extracted_variables": [ { "key": "customer_issue", "prompt": "Identify the main issue the customer is experiencing." } ] }, "slack": { "extracted_variables": [ { "key": "customer_issue", "prompt": "Identify the main issue the customer is experiencing." } ] }, "salesforce": { "extracted_variables": [ { "key": "customer_issue", "prompt": "Identify the main issue the customer is experiencing." } ] }, "hubspot": { "extracted_variables": [ { "key": "customer_issue", "prompt": "Identify the main issue the customer is experiencing." } ] }, "zoho_bigin": { "extracted_variables": [ { "key": "customer_issue", "prompt": "Identify the main issue the customer is experiencing." } ] } } }'
{ "success": true, "status": "dispatched", "requestId": 3166940, "custom_variables_count": 1 }
BearerAuthAuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
application/jsonuser_id?ClientUserIdReseller keys only: act as one of your clients by its user id. Omit it to act on your own account. How acting for a client works.
agent_id*integerThe ID of the agent that will handle the call.
to_number*stringThe phone number to call. Must include country code (e.g., +15551234567).
from_number_id?integerId of a phone number on your account to place the call from (see the phone number list endpoint). Omit to use the platform's default number.
call_context?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.
metadata?Key-value pairs stored on the call for your own tracking
(e.g. CRM or lead IDs). Not shared with the agent; echoed
back as metadata in the post-call webhook so you can
correlate results with your records.
__languages?array<string> | stringLanguages this call runs in, replacing the agent's configured
list for this call only. The first entry is the language the
call opens in. Send an array, or a pipe-separated string such
as Hindi|English. Names the platform does not recognize are
skipped and listed in languages_ignored.
__post_call_actions?Post-call actions for this call only, in the same shape as
post_call_actions on agent create. Email and webhook only.
They replace the agent's own post-call actions for this call;
the agent is not changed. Items that cannot be used are
skipped and listed in post_call_actions_ignored, and the
call still goes out. Can also be sent inside call_context.
Response body
application/jsonCall dispatched.
application/jsonsuccess?booleanstatus?stringDispatch state on the platform side. dispatched means the call has been queued for the dialer.
requestId?integerInternal call request id. Use it to correlate with call_request_id on /calls/logs.
custom_variables_count?integerNumber of keys the platform extracted from call_context.
languages_applied?array<string>Languages this call runs in. Empty when no __languages was sent or none were recognized, in which case the agent's own languages are used.
languages_ignored?array<string>Names from __languages that were not recognized and were skipped.
post_call_actions_applied?array<string>Channels from __post_call_actions that will run for this call. Present only when __post_call_actions was sent.
post_call_actions_ignored?Items from __post_call_actions that were skipped. Present only when __post_call_actions was sent. When nothing was applied, the agent's own post-call actions run.
Was this page helpful?