Send Voice Calls with an Agent

post

https://api.liguelead.com.br/v1/voice-agent/call

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

title

string

required

length ≤ 200

Campaign title (1–200 characters).

voice_agent_id

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*

retry_attempts

integer

1 to 3

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

retry_interval_min

integer

5 to 180

Minutes between retry attempts.

retry_end_time

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.

webhook_url

uri

length ≤ 512

Optional. URL that receives the status events (campaign.status) of this send instead of the app's webhook URL, in the same model as the Twilio StatusCallback. It is called exactly as written, query string included, so it can carry your own identifiers (for example ?order=123). Replies and button postbacks keep going to the app's webhook URL. Must use http or https, have a public hostname without underscores and be at most 512 characters; private and reserved addresses are refused. No authentication header is sent to it.

Responses

Callback

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Calls accepted and enqueued

404Voice agent not found or does not belong to the client.

422Validation error (invalid UUID, empty/oversized phones list, invalid retry_end_time, or invalid call_context — empty, whitespace-only, or over 1500 characters after normalization).