Skip to navigation
API ReferenceCampaign Contacts

List campaign contacts

Lista contatos de campanha.

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

datetime, opcional. Contatos criados no intervalo.

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

filter[campaign_id]stringOptional

integer, opcional. Contatos presentes na campanha informada.

Ex: filter[campaign_id]=1

filter[status]stringOptional

enum, opcional. Contatos cujo status seja igual ao valor.

Valores:

  • 1 — Pendente
  • 2 — Discando
  • 3 — Falha
  • 4 — Em progresso
  • 5 — Completado
  • 6 — Chamada agendada
  • 7 — Descartado
  • 9 — Pós-atendimento
  • 10 — URA
  • 11 — Suspenso

Ex: filter[status]=1

filter[blocked]stringOptional

boolean, opcional. Apenas contatos bloqueados manualmente (não inclui telefones em listas de bloqueio).

Ex: filter[blocked]=true

sortstringOptional

Ordenável por: created_at, updated_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.