Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body to place an outbound voice call. The call is answered by the voice agent configured on the sender.

to
string
required

Recipient phone number in E.164 format.

Example:

"+56912345678"

senderId
string

Sender profile that places the call. Uses the project's default sender if omitted. The sender's agent must have voice enabled.

Example:

"sender_12345"

greeting
string

Overrides the agent's configured greeting for this call only.

Maximum string length: 1000
language
string

Language the agent speaks on this call only, as a BCP-47 tag (en, es, es-ES, pt-BR), or auto to detect the caller's language and follow it. Overrides the agent's configured language for speech recognition, the agent's replies, and the synthesized voice. If the agent uses a custom voice you supplied, that voice is kept and only the language changes. When omitted, the agent's configured language is used.

Maximum string length: 15
Example:

"es-ES"

maxDurationMinutes
integer

Overrides the agent's maximum call duration for this call only.

Required range: 1 <= x <= 120
metadata
object

Arbitrary metadata to associate with the call. Returned on the call object and included in voice webhooks.

Response

Call accepted and dialing.

call
object
required