Skip to navigation
API ReferenceCampaign Completed Calls

List (with transcriptions)

Lista chamadas de campanha completadas já carregando as transcrições (include=transcriptions). A transcrição traz texto completo, utterances com separação de speakers, contadores de sentimento, resumo e notas.

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). Retorna apenas chamadas iniciadas no intervalo.

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

filter[campaign]stringOptional

integer, opcional. Chamadas cuja campanha seja igual ao valor.

Ex: filter[campaign]=3

filter[campaign_contact]stringOptional

integer, opcional. Chamadas cujo contato de campanha seja igual ao valor.

Ex: filter[campaign_contact]=2

filter[campaign_list]stringOptional

integer, opcional. Chamadas cuja lista de campanha seja igual ao valor.

Ex: filter[campaign_list]=4

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[destination_phone]stringOptional

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

Ex: filter[destination_phone]=987654321

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

Ex: filter[hangup_cause]=1

filter[agent]stringOptional

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

Ex: filter[agent]=1

includestringRequired

Relacionamentos incluíveis: campaign, campaign_contact, campaign_list, qualification, agent, transfer_agent, 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.