Endpoints
Calls
AI phone calls placed by the Coordinator: history, summaries, transcripts and new calls.
Os caminhos são relativos à URL base. Cada card lista a permissão que a chamada exige e todos os parâmetros, com tipo e limites.
/callsList calls, newest first. Summaries and transcripts are left out of the list.
Parâmetros de query
- directionopcionalenum
Call direction.
Valores permitidos:
inboundoutbound - outcomeopcionalstring
Call outcome, up to 50 characters.
- contact_idopcionalinteger
Calls with this contact.
- fromopcionalstring (ISO 8601 date-time with offset)
Calls created at or after this time.
- toopcionalstring (ISO 8601 date-time with offset)
Calls created at or before this time.
/calls/:idRetrieve a call with its outcome, summary and transcript.
Parâmetros de caminho
- idobrigatóriostring
Call ID (a UUID).
/callsHave the AI call one person. Send exactly one of contact_id or phone.
Corpo JSON
- contact_idopcionalinteger
The contact to call.
- phoneopcionalstring (E.164)
Number to call, e.g. +14155550123. A contact is found or created for it.
- template_idopcionalstring
A call template of this workspace. Send template_id or instructions.
- instructionsopcionalstring
What the AI should achieve on the call, 1–8,000 characters. Used when no template is given.
- purposeopcionalstring
Alias of instructions.
- channel_idopcionalinteger
The phone or WhatsApp channel to call from (see GET /channels). It must be able to place outbound calls.
- scheduled_atopcionalstring (ISO 8601 date-time with offset)
Call later instead of now.
- Answers 201 with the queued call (status "pending").
- 403 coordinator_disabled until the Coordinator is enabled for the workspace; 422 number_blocked for a number on the call blocklist; 422 do_not_call for a Do-Not-Call contact; 422 channel_not_connected when no channel can place the call.
/calls/queueQueue AI calls to several contacts.
Corpo JSON
- contact_idsobrigatórioarray of integers
1–500 contact IDs.
- template_idopcionalstring
A call template of this workspace. Send template_id or instructions.
- instructionsopcionalstring
What the AI should achieve on the call, 1–8,000 characters. Used when no template is given.
- purposeopcionalstring
Alias of instructions.
- channel_idopcionalinteger
The phone or WhatsApp channel to call from (see GET /channels). It must be able to place outbound calls.
- scheduled_atopcionalstring (ISO 8601 date-time with offset)
Call later instead of now.
- Answers 201 with the queued calls plus queued, skipped_do_not_call and skipped_not_found counts.
/calls/queue/:idCancel a queued call that has not started yet.
Parâmetros de caminho
- idobrigatóriostring
Queued call ID.