Skip to main content
POST
Place an outbound call

Authorizations

X-API-KEY
string
header
required

Body

application/json
agent_id
string
required

A published voice agent.

to_number
string
required

Destination in E.164, e.g. +919876543210.

callee_name
string
Maximum string length: 128
from_phone_number_id
string

Caller ID to dial from.

custom_variables
object

Scalar values substituted into the agent's prompt. Max 64 keys, 30 KB total.

metadata
object

Opaque JSON echoed back. Max 16 KiB.

idempotency_key
string

A repeat of the same key returns 409 instead of dialling twice.

Pattern: ^[A-Za-z0-9_.:-]{1,128}$
call_config
object
smart_formatter
object

Accepted and echoed back for contract compatibility, but NOT applied to the call.

Response

The call record. to_number is never echoed — only to_number_masked.