Skip to main content
POST
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Body

application/json
agent_id
string
required

A voice agent's id: the id from List or get agents.

additional_variables
Additional Variables · object | null

Extra {{key}} variables resolved into the agent prompt at call time.

from_number
string | null

Outbound caller ID in E.164 format. When omitted, uses the first active phone number configured for the workspace.

idempotency_key
string | null

Idempotency key returned by the Sendora API.

Maximum string length: 128
lead_id
string | null

A lead's id: the id from List or get leads.

mode
enum<string> | null

With test: browser starts a web call, phone rings the number in test_phone.

Available options:
browser,
phone
prompt_override
string | null

Override the agent system prompt for this single call. Supports {{lead.*}} tokens.

Maximum string length: 8000
test
boolean
default:false

Place a test call to try an agent instead of calling a lead.

test_phone
PhoneTestCallRequest · object | null

With mode phone: where to ring.

voice_id
string | null

A voice's id: the id from List voices.

voicemail
VoicemailConfig · object | null

Voicemail returned by the Sendora API.

Response

Successful Response

call_id
string
required

The call's tracking id. Pass it to List or get calls once the call has ended.

status
string
required

dialing | failed | skipped

message
string | null

Message returned by the Sendora API.