Skip to main content
GET
Listar conversas

Autorizações

Authorization
string
header
obrigatório

Token JWT de autenticação

Cabeçalhos

x-company-id
string

Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.

Parâmetros de consulta

inboxId
string

Filtrar por ID do inbox

agentId
string

Filtrar por ID do agente

teamId
string

Filtrar por ID do time

channel
string

Filtrar por tipo(s) de canal do inbox, separados por virgula (ex: WAP_AUTO_CLOSER,LINKEDIN)

stalled
string

Filtrar conversas paradas (sem atividade do contato há mais de 24h)

transferred
string

Filtrar conversas transferidas de IA para atendente humano

hasFollowUp
string

Filtrar conversas com follow-up agendado

inCampaign
string

Filtrar conversas originadas de campanha

inService
string

Filtrar conversas em atendimento (exclui follow-up e campanha)

userIds
string

Filtrar por IDs dos usuários

whoAnswering
string

Filtrar por quem está respondendo (AGENT/HUMAN)

status
string

Filtrar por status (OPEN, RESOLVED)

agentStep
string

Filtrar por IDs dos passos do fluxo do agente

engagement
string

Filtrar por níveis de engajamento

requiresAttention
string

Filtrar conversas que requerem atenção

startDate
string

Data inicial para filtrar conversas (createdAt >= startDate)

endDate
string

Data final para filtrar conversas (createdAt <= endDate)

advancedFilters
string

Filtros avançados em formato JSON: [{ field, operator, value }]

page
string
padrão:1

Número da página (começa em 1)

rowsPerPage
string
padrão:10

Quantidade de itens por página

Resposta

Lista de conversas retornada com sucesso

result
any[]
obrigatório

Lista de conversas

meta
any
obrigatório

Metadados da paginação