Skip to main content
GET
Get Chat History
Recupere o histórico de conversas de um canal para auditar interações, analisar métricas ou depurar fluxos. Este endpoint retorna mensagens enviadas e recebidas com suporte a paginação e filtros de tempo.

Endpoint


Parâmetros de Path


Parâmetros de Query

Se você omitir campos opcionais, a API aplicará valores padrão para entregar a primeira página com as mensagens mais recentes.

Exemplos de Requisição

Consulta básica

Com filtro de data

Com filtro de cliente


Respostas


Detalhes da Resposta

Objeto pagination

Objeto results


Limites e restrições

Limites importantes:
  • limit: O valor máximo permitido é 50
  • page: Deve ser um inteiro positivo
  • startAt/endAt: Devem estar no formato ISO 8601 (ex.: 2025-01-15T10:30:00.000Z)

Autorizações

Authorization
string
header
obrigatório

Basic authentication using Base64 encoded clientId:clientSecret

Parâmetros de caminho

botId
string
obrigatório

Parâmetros de consulta

limit
integer
padrão:10
Intervalo obrigatório: x <= 50
page
integer
padrão:1
startAt
string<date-time>
endAt
string<date-time>
clientId
string
messageId
string

Resposta

History retrieved successfully

pagination
object
_metadata
object
results
object[]