Skip to navigation
API ReferenceOutgoing Missed Calls

List

Lista chamadas efetuadas não completadas (com falha).

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

enum, opcional. Chamadas cujo motivo de falha seja igual ao valor.

Valores:

  • 1 — Telefone não atendeu
  • 2 — Telefone não existe
  • 3 — Chamada cancelada
  • 4 — Chamada rejeitada
  • 5 — Telefone mudou
  • 6 — Telefone ocupado
  • 7 — Caixa postal
  • 8 — Abandono pelo contato
  • 9 — Abandono por falta de agentes
  • 10 — Temporariamente indisponível
  • 12 — Opção incorreta de URA
  • 13 — Erro do sistema
  • 14 — Telefone inválido
  • 15 — Bloqueado
  • 16 — Desbloqueado
  • 17 — Chamada bloqueada pela operadora
  • 18 — Bloqueio Institucional
  • 19 — Caixa postal evitada por IA

Ex: filter[failure_cause]=1

includestringOptional

Relacionamentos incluíveis: agent.

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.