Skip to main content
POST
Trigger Call

Request Body

string
required
Phone number in E.164 format (e.g., +14155551234). Must start with + followed by country code and number.
string
required
Contact’s display name. Maximum 128 characters.
string
required
The ID of the agent that will handle this call. Must reference an existing agent in your account.
object
Optional key-value pairs injected into the agent’s prompt. Maximum 20 entries. Keys max 64 characters. Every value must be a string, max 512 characters. The same values are returned in the call’s webhooks as data.dynamicVariables.Example: {"company": "Acme Corp", "plan": "Enterprise"}
boolean
Optional. If true, a call that cannot be placed right now because the calling window is closed or the voice service is briefly unavailable is queued instead of refused. The response is then 202 Accepted with data.status set to "deferred", plus reason, notBefore, deferredCallId and contactUID. Must be a boolean.
object
Optional retry configuration for failed call attempts.

Response

boolean
Indicates if the call was triggered successfully.
object

Error Codes

The concurrent-call limit is set per account by Oktivo. It is not shown in the dashboard; ask Oktivo support for the current value.
This endpoint accepts both API Token (okt_...) and JWT authentication.