Vai al contenuto
Sviluppatori

Endpoint

Calls

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

I percorsi sono relativi all'URL di base. Ogni scheda indica il permesso richiesto dalla chiamata e ogni parametro, con tipo e limiti.

GET
/calls

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

Permesso: call_agent
Paginato

Parametri di query

  • directionopzionaleenum

    Call direction.

    Valori consentiti:inboundoutbound

  • outcomeopzionalestring

    Call outcome, up to 50 characters.

  • contact_idopzionaleinteger

    Calls with this contact.

  • fromopzionalestring (ISO 8601 date-time with offset)

    Calls created at or after this time.

  • toopzionalestring (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.

Permesso: call_agent

Parametri del percorso

  • idobbligatoriostring

    Call ID (a UUID).

POST
/calls

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

Permesso: call_agent

Corpo JSON

  • contact_idopzionaleinteger

    The contact to call.

  • phoneopzionalestring (E.164)

    Number to call, e.g. +14155550123. A contact is found or created for it.

  • template_idopzionalestring

    A call template of this workspace. Send template_id or instructions.

  • instructionsopzionalestring

    What the AI should achieve on the call, 1–8,000 characters. Used when no template is given.

  • purposeopzionalestring

    Alias of instructions.

  • channel_idopzionaleinteger

    The phone or WhatsApp channel to call from (see GET /channels). It must be able to place outbound calls.

  • scheduled_atopzionalestring (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.

Permesso: call_agent

Corpo JSON

  • contact_idsobbligatorioarray of integers

    1–500 contact IDs.

  • template_idopzionalestring

    A call template of this workspace. Send template_id or instructions.

  • instructionsopzionalestring

    What the AI should achieve on the call, 1–8,000 characters. Used when no template is given.

  • purposeopzionalestring

    Alias of instructions.

  • channel_idopzionaleinteger

    The phone or WhatsApp channel to call from (see GET /channels). It must be able to place outbound calls.

  • scheduled_atopzionalestring (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.

Permesso: call_agent

Parametri del percorso

  • idobbligatoriostring

    Queued call ID.