Skip to navigation
API ReferenceOutgoing Completed Calls

List (with transcriptions)

Lista chamadas efetuadas (manuais/click-to-call/callback/rechamada) completadas, com transcrições via include=transcriptions.

Suporta os parâmetros universais JSON:API (paginação, ordenação, include, sparse fieldsets) — veja as convenções.

Authentication

AuthorizationBearer
Token de API da conta do tenant.

Query parameters

filter[started_at]stringOptional

datetime, opcional (janela máxima de 31 dias). Chamadas iniciadas no intervalo.

Ex: filter[started_at]=2018-06-01T00:00:00.000Z,2018-06-01T23:59:59.999Z

filter[destination_phone]stringOptional

string, opcional. Chamadas cujo telefone de destino contenha o valor.

Ex: filter[destination_phone]=987654321

filter[call_type]stringOptional

enum, opcional. Chamadas cujo tipo seja igual ao valor.

Valores:

  • 1 — Chamada Manual
  • 2 — Callback
  • 3 — Rechamada
  • 5 — Click To Call

Ex: filter[call_type]=1

filter[click_to_call_id]stringOptional

string (UUID), opcional. Chamadas cujo click_to_call_id seja igual ao valor.

Ex: filter[click_to_call_id]=4e413b14-3a8d-4cca-a4d7-628a634f23d8

filter[extension]stringOptional

integer, opcional. Chamadas cujo ramal contenha o valor.

Ex: filter[extension]=220

filter[agent]stringOptional

integer, opcional. Chamadas cujo agente seja igual ao valor.

Ex: filter[agent]=1

filter[qualification]stringOptional

integer, opcional. Chamadas cuja qualificação seja igual ao valor.

Ex: filter[qualification]=1

filter[protocol]stringOptional

integer, opcional. Chamada cujo protocolo seja igual ao valor.

Ex: filter[protocol]=2

filter[note]stringOptional

string, opcional (case-insensitive). Chamadas cuja observação contenha o valor.

Ex: filter[note]=Chamada Muda

filter[hangup_cause]stringOptional

enum, opcional. Chamadas desligadas pelo valor informado.

Valores:

  • 1 — Cliente desligou
  • 2 — Operador desligou
  • 3 — Sistema desligou
  • 4 — Interrupção
  • 5 — Callback
  • 6 — Limite de tempo
  • 7 — Supervisor
  • 8 — Transferência para WhatsApp

Ex: filter[hangup_cause]=1

includestringRequired

Relacionamentos incluíveis: agent, qualification, customer, transcriptions.

sortstringOptional

Ordenável por: started_at.

page[limit]stringOptional

integer, opcional. Quantidade máxima de itens por página.

page[offset]stringOptional

integer, opcional. Deslocamento (quantos itens pular) para paginação.

Response

Sucesso.