Aller au contenu
Développeurs

Endpoints

Calls

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

Les chemins sont relatifs à l’URL de base. Chaque carte indique la permission requise par l’appel et chaque paramètre, avec son type et ses limites.

GET
/calls

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

Permission : call_agent
Paginé

Paramètres de requête

  • directionfacultatifenum

    Call direction.

    Valeurs autorisées :inboundoutbound

  • outcomefacultatifstring

    Call outcome, up to 50 characters.

  • contact_idfacultatifinteger

    Calls with this contact.

  • fromfacultatifstring (ISO 8601 date-time with offset)

    Calls created at or after this time.

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

Permission : call_agent

Paramètres de chemin

  • idobligatoirestring

    Call ID (a UUID).

POST
/calls

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

Permission : call_agent

Corps JSON

  • contact_idfacultatifinteger

    The contact to call.

  • phonefacultatifstring (E.164)

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

  • template_idfacultatifstring

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

  • instructionsfacultatifstring

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

  • purposefacultatifstring

    Alias of instructions.

  • channel_idfacultatifinteger

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

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

Permission : call_agent

Corps JSON

  • contact_idsobligatoirearray of integers

    1–500 contact IDs.

  • template_idfacultatifstring

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

  • instructionsfacultatifstring

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

  • purposefacultatifstring

    Alias of instructions.

  • channel_idfacultatifinteger

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

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

Permission : call_agent

Paramètres de chemin

  • idobligatoirestring

    Queued call ID.