Listar ligações
Lista as ligações do alcance do chamador, da mais recente para a mais antiga. O universo é o das ligações que existiram: um agendamento que nunca discou é um job e está em /call-jobs. Os ensaios do estúdio ficam de fora por padrão — include_studio=true os traz. A ordem é por início da ligação, que não muda depois de gravado, então a lista não embaralha enquanto se pagina.
Autorização
bearer calls:readCredencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.
Em: header
Escopo: calls:read
Parâmetros de consulta
Estreita para um cliente (dentro do alcance).
int64Só as ligações deste agente de voz.
uuidoutbound ou inbound.
Valor em
- "outbound"
- "inbound"
O estado gravado da ligação.
Valor em
- "pending"
- "queued"
- "dispatched"
- "dialing"
- "answered"
- "no_answer"
- "busy"
- "rejected"
- "voicemail"
- "invalid_number"
- "transferred"
- "rescheduled"
- "failed"
- "cancelled"
- "completed"
- "bootstrapped"
- "active"
- "ringing"
- "scheduled"
- "dispatching"
O desfecho comercial, na taxonomia fixa da plataforma.
Valor em
- "ganho"
- "avancou"
- "sem_avanco"
- "descartado"
- "sem_contato"
- "nao_classificado"
Quem classificou: agent, model, derived ou human.
Valor em
- "agent"
- "model"
- "derived"
- "human"
Inclui os ensaios do estúdio, que ficam de fora por padrão.
Só as ligações iniciadas a partir deste instante.
date-timeSó as ligações iniciadas até este instante.
date-timeTrecho do telefone do contato, como a pessoa digitou.
Cursor opaco devolvido em page.next_cursor da página anterior. Omita para começar do início.
Tamanho da página. Padrão 50; o máximo é o da coleção: 200, ou até 500 nas coleções de itens pequenos.
int320 <= valueCorpo da resposta
application/json
application/json
curl -X GET "https://example.com/calls"{ "data": [ { "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978", "answered_at": "string", "contact_name": "string", "contact_phone": "string", "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407", "created_at": "string", "direction": "outbound", "duration_ms": 0, "ended_at": "string", "error": null, "from_number": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "job": null, "message_count": 0, "provider": "string", "result_summary": null, "started_at": "string", "status": "pending", "studio": true, "tenant_id": 0, "to_number": "string", "updated_at": "string" } ], "page": { "has_more": true, "next_cursor": "string" }}