Skip to main content
GET
Consultar relatório de conversas

Autorizações

Authorization
string
header
obrigatório

Token da API no formato sk_live_….

Parâmetros de consulta

page
integer
padrão:1

Número da página, começando em 1. Um valor inválido é tratado como 1.

Intervalo obrigatório: x >= 1
perPage
integer
padrão:20

Quantidade de itens por página. O máximo depende do ambiente (padrão 100).

Intervalo obrigatório: 1 <= x <= 100
date_start
string
obrigatório

Início do período, no fuso da empresa: AAAA-MM-DD ou AAAA-MM-DD HH:mm:ss. Só com a data, conta a partir de 00:00:00.

date_finish
string
obrigatório

Fim do período, no mesmo formato. Só com a data, vale até 23:59:59 daquele dia.

dateType
enum<string>
padrão:updated

updated considera as datas de criação, conclusão e atualização. created considera só a data de criação.

Opções disponíveis:
updated,
created
days
integer

Alternativa ao período: os últimos N dias.

status
string
users
string

Ids dos atendentes (o id de GET /users), separados por vírgula. Atendente que não é da sua empresa responde 404 (ERR_API_USER_NOT_FOUND).

queues
string

Ids das filas, separados por vírgula. Id que não é da sua empresa responde 422 (ERR_API_INVALID_REFERENCE).

channels
string

Ids dos canais, separados por vírgula. Id que não é da sua empresa responde 422 (ERR_API_INVALID_REFERENCE).

tags
string

Ids das tags, separados por vírgula. Id que não é da sua empresa responde 422 (ERR_API_INVALID_REFERENCE).

wrapupTypes
string

Ids das qualificações, separados por vírgula. Id que não é da sua empresa responde 422 (ERR_API_INVALID_REFERENCE).

contactSearchParams
string

Busca por contato.

protocol
string

Número de protocolo do atendimento.

conversationType
enum<string>

Tipo da conversa: receptiva, ativa, por campanha ou por agendamento. Como a conversa começou:

Opções disponíveis:
incoming,
outcoming,
campaign,
outcoming_api,
outcoming_automation,
outcoming_schedule

Resposta

OK

data
object[]
meta
object
Exemplo: