Get Chat History
Conversações
Histórico de chat
Consulte o histórico de mensagens de um bot
GET
Get Chat History
Recupere o histórico de conversas de um bot 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.Documentation Index
Fetch the complete documentation index at: https://docs.jelou.ai/llms.txt
Use this file to discover all available pages before exploring further.
Endpoint
Parâmetros de Path
| Campo | Localização | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| botId | Path | string | Sim | Identificador único do bot cujo histórico você deseja consultar. |
Parâmetros de Query
| Campo | Localização | Tipo | Obrigatório | Valor padrão | Descrição |
|---|---|---|---|---|---|
| limit | Query | integer | Não | 10 | Número de mensagens a solicitar. Máximo: 50. |
| page | Query | integer | Não | 1 | Número da página. |
| startAt | Query | date | Não | - | Data de início do intervalo a consultar. Formato ISO 8601. |
| endAt | Query | date | Não | - | Data de término do intervalo a consultar. Formato ISO 8601. |
| clientId | Query | string | Não | - | Filtra o histórico por um clientId específico associado às suas integrações. |
| messageId | Query | string | Não | - | Retorna a conversa que contém a mensagem com este identificador. |
Exemplos de Requisição
Consulta básica
Com filtro de data
Com filtro de cliente
Respostas
200 - Resposta bem-sucedida
200 - Resposta bem-sucedida
401 - Não Autorizado
401 - Não Autorizado
404 - Não Encontrado
404 - Não Encontrado
422 - Entidade não processável
422 - Entidade não processável
500 - Erro Interno do Servidor
500 - Erro Interno do Servidor
Detalhes da Resposta
Objeto pagination
| Campo | Tipo | Descrição |
|---|---|---|
| limit | integer | Número de registros por página. |
| page | integer | Página atual. |
| total | integer | Total de registros. |
| offset | integer | Deslocamento a partir do início. |
| totalPages | integer | Total de páginas disponíveis. |
Objeto results
| Campo | Tipo | Descrição |
|---|---|---|
| recipient | object | Informações do destinatário (id, names). |
| sender | object | Informações do remetente (id, name, type). |
| by | string | Indica quem enviou a mensagem: bot ou user. |
| messageId | string | Identificador único da mensagem. |
| status | string | Status da mensagem: DELIVERED_USER, DELIVERED_CHANNEL, READ, etc. |
| bubble | object | Conteúdo da mensagem (type, text, mediaUrl, etc.). |
| createdAt | date | Data de criação da mensagem no formato ISO 8601. |
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
Basic authentication using Base64 encoded clientId:clientSecret
Parâmetros de caminho
Parâmetros de consulta
Intervalo obrigatório:
x <= 50