Send Voice Calls with an Agent

Dispatches AI-driven phone calls to a list of recipients using a voice agent. Processing is asynchronous: a 202 Accepted response means the calls were enqueued. The optional retry_* fields control automatic re-dialing of unanswered calls and only take effect when retry_attempts is provided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 200

Campaign title (1–200 characters).

uuid
required

ID of the voice agent that drives the calls. Must exist and belong to the authenticated client.

phones
array
required
length between 1 and 1000

Phone numbers to dial (1–1000 per request). Each item is either a plain phone number string (legacy format) or an object { phone, call_context } used to attach free-text, per-call context. Note: a large batch (up to 1000 phones) where most items carry a near-maximum call_context (1500 characters) can push the JSON payload past the server's 250kb request body limit, which returns 413 Payload Too Large before validation even runs — this is a practical limitation to keep in mind, not a bug.

phones*
integer
1 to 3

Re-dial attempts for unanswered calls. When omitted, retries are disabled.

integer
5 to 180

Minutes between retry attempts.

string
^([01][0-9]|2[0-3]):[0-5][0-9]$

Cutoff time for retries in HH:MM format. Must be between 08:00 and 21:45 (America/Sao_Paulo) and at least 10 minutes in the future.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json