Skip to main content
POST
Make outbound call

Autorizaciones

Authorization
string
header
requerido

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

Cuerpo

application/json
from_number
string
requerido

The phone number of the caller. You can use one of your phone numbers in E.164 format or the unique identifier of the phone number.

to_number
string
requerido

The phone number of the called party in E.164 format.

dynamic_variables
Dynamic Variables · object | null

A dictionary of dynamic variables to be substitute the variables in the prompt

agent_version_id
string<uuid> | null

The unique identifier of the agent version to handle the call.

Respuesta

Successful Response

id
string<uuid>
requerido

The unique identifier for the call

agent_id
string<uuid> | null
requerido

The unique identifier for the agent that handled the call

agent_version_id
string<uuid> | null
requerido

The unique identifier for the agent version that handled the call

status
enum<string>
requerido

The current status of the call

Opciones disponibles:
dialing,
in_queue,
in_progress,
completed
type
enum<string>
requerido

The direction of the phone call

Opciones disponibles:
inbound,
outbound
contact
Contact · object
requerido

Details of the contact that initiated or received the call

phone_register_id
string<uuid> | null
requerido

The ID of the phone that was used to make or receive the call

created_date
string<date-time>
requerido

The date and time when the call was created

recording_url
string | null

The call recording URL.

start_time
string<date-time> | null

The start time of the call

end_time
string<date-time> | null

The end time of the call, if ended

duration
integer | null

The call duration in seconds. null if the call has not ended

end_reason
string | null

The reason for call termination, if the call has ended

dynamic_variables
Dynamic Variables · object | null

A dictionary of dynamic variables that were used during the call