Get Chat History
Conversaciones
Historial de chat
Consulta el historial de mensajes de un bot
GET
Get Chat History
Obtén el historial de conversaciones de un bot para auditar interacciones, analizar métricas o depurar flujos. Este endpoint retorna los mensajes enviados y recibidos con soporte para paginación y filtros de tiempo.
Endpoint
Parámetros de ruta
| Campo | Ubicación | Tipo | Requerido | Descripción |
|---|---|---|---|---|
| botId | Path | string | Sí | Identificador único del bot del que deseas consultar el historial. |
Parámetros de consulta
| Campo | Ubicación | Tipo | Requerido | Valor por defecto | Descripción |
|---|---|---|---|---|---|
| limit | Query | integer | No | 10 | Número de mensajes a solicitar. Máximo: 50. |
| page | Query | integer | No | 1 | Número de página. |
| startAt | Query | date | No | - | Fecha de inicio del rango a consultar. Formato ISO 8601. |
| endAt | Query | date | No | - | Fecha fin del rango a consultar. Formato ISO 8601. |
| clientId | Query | string | No | - | Filtra el historial por un clientId específico asociado a tus integraciones. |
| messageId | Query | string | No | - | Devuelve la conversación que contiene el mensaje con este identificador. |
Ejemplos de solicitud
Consulta básica
Con filtro de fechas
Con filtro de cliente
Respuestas
200 - Respuesta exitosa
200 - Respuesta exitosa
401 - Unauthorized
401 - Unauthorized
404 - Not Found
404 - Not Found
422 - Unprocessable Entity
422 - Unprocessable Entity
500 - Internal Server Error
500 - Internal Server Error
Detalle de la respuesta
Objeto pagination
| Campo | Tipo | Descripción |
|---|---|---|
| limit | integer | Número de registros por página. |
| page | integer | Página actual. |
| total | integer | Total de registros. |
| offset | integer | Desplazamiento desde el inicio. |
| totalPages | integer | Total de páginas disponibles. |
Objeto results
| Campo | Tipo | Descripción |
|---|---|---|
| recipient | object | Información del destinatario (id, names). |
| sender | object | Información del remitente (id, name, type). |
| by | string | Indica quién envió el mensaje: bot o user. |
| messageId | string | Identificador único del mensaje. |
| status | string | Estado del mensaje: DELIVERED_USER, DELIVERED_CHANNEL, READ, etc. |
| bubble | object | Contenido del mensaje (type, text, mediaUrl, etc.). |
| createdAt | date | Fecha de creación del mensaje en formato ISO 8601. |
Límites y restricciones
Límites importantes:
- limit: Valor máximo permitido es
50 - page: Debe ser un número entero positivo
- startAt/endAt: Deben estar en formato ISO 8601 (ej:
2025-01-15T10:30:00.000Z)
Autorizaciones
Basic authentication using Base64 encoded clientId:clientSecret
Parámetros de ruta
Parámetros de consulta
Rango requerido:
x <= 50