Endpoints

Calls

AI phone calls placed by the Coordinator: history, summaries, transcripts and new calls.

Pfade sind relativ zur Basis-URL. Jede Karte zeigt die Berechtigung, die der Aufruf braucht, und jeden Parameter mit Typ und Grenzen.

GET

/calls

List calls, newest first. Summaries and transcripts are left out of the list.

Berechtigung: call_agent

Paginiert

directionoptionalenum
Call direction.
Erlaubte Werte:inboundoutbound
outcomeoptionalstring
Call outcome, up to 50 characters.
contact_idoptionalinteger
Calls with this contact.
fromoptionalstring (ISO 8601 date-time with offset)
Calls created at or after this time.
tooptionalstring (ISO 8601 date-time with offset)
Calls created at or before this time.

GET

/calls/:id

Retrieve a call with its outcome, summary and transcript.

Berechtigung: call_agent

POST

/calls

Have the AI call one person. Send exactly one of contact_id or phone.

Berechtigung: call_agent

contact_idoptionalinteger
The contact to call.
phoneoptionalstring (E.164)
Number to call, e.g. +14155550123. A contact is found or created for it.
template_idoptionalstring
A call template of this workspace. Send template_id or instructions.
instructionsoptionalstring
What the AI should achieve on the call, 1–8,000 characters. Used when no template is given.
purposeoptionalstring
Alias of instructions.
channel_idoptionalinteger
The phone or WhatsApp channel to call from (see GET /channels). It must be able to place outbound calls.
scheduled_atoptionalstring (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.

POST

/calls/queue

Queue AI calls to several contacts.

Berechtigung: call_agent

contact_idserforderlicharray of integers
1–500 contact IDs.
template_idoptionalstring
A call template of this workspace. Send template_id or instructions.
instructionsoptionalstring
What the AI should achieve on the call, 1–8,000 characters. Used when no template is given.
purposeoptionalstring
Alias of instructions.
channel_idoptionalinteger
The phone or WhatsApp channel to call from (see GET /channels). It must be able to place outbound calls.
scheduled_atoptionalstring (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.

DELETE

/calls/queue/:id

Cancel a queued call that has not started yet.

Berechtigung: call_agent