Saltar al contenido principal
POST
cURL

Autorizaciones

Authorization
string
header
requerido

Add api-key YOUR_API_SECRET_KEY as the value of the Authorization header.

Cuerpo

application/json
agent_id
string<uuid4>
requerido

Unique identifier of the Agent that will participate in the Call (formerly Chatbot or Assistant)

phone_number_to
string<e164>
requerido

E.164 formatted phone number of the EndUser to call

end_user_display_name
string

Display name of the EndUser to call

end_user_context

Context of the EndUser to call

initial_message
string

Initial message the Agent will say upon the call being answered

Respuesta

Call response

id
string

Unique identifier for the Call

thread
object
type
enum<string>

Type of the Call

Opciones disponibles:
inbound,
outbound
status
enum<string>

Status of the Call

Opciones disponibles:
created,
queued,
ringing,
in-progress,
forwarding,
ended,
busy,
no-answer,
failed
answered_by
enum<string>

Who or what answered the Call

Opciones disponibles:
human,
machine,
unknown
created_at
string<date-time>

Datetime from when the Call was created

started_at
string<date-time>

Datetime from when the Call was started

ended_at
string<date-time>

Datetime from when the Call was ended

ended_by
enum<string>

Who ended the Call (agent, user or system). Empty if the call never connected

Opciones disponibles:
agent,
user,
system,
ended_reason
string

Brief reason why the Call ended. Empty if not available

duration
integer

Duration of the Call in seconds

billable_duration
integer

Billable duration of the Call in seconds

policy_evaluation
object

Policy compliance evaluation results