Endpoint
Autenticación
| Campo | Ubicación | Tipo | Requerido | Descripción |
|---|---|---|---|---|
| Authorization | Header | string | Sí | Credenciales en formato clientId:clientSecret. |
Parámetros de consulta
| Campo | Ubicación | Tipo | Requerido | Valor por defecto | Descripción |
|---|---|---|---|---|---|
| limit | Query | integer | No | 10 | Número máximo de conversaciones por página. |
| page | Query | integer | No | 1 | Número de página para paginación. |
Cuerpo de la solicitud
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| startAt | string | Sí | Fecha de inicio del rango en formato ISO 8601. Ejemplo: 2025-01-01T00:00:00-05:00 |
| endAt | string | Sí | Fecha de fin del rango en formato ISO 8601. Ejemplo: 2025-01-01T23:59:59-05:00 |
| getJson | boolean | Sí | Debe ser true para recibir la respuesta en formato JSON. |
Ejemplos de solicitud
- cURL
- JavaScript
Respuestas
200 - Respuesta exitosa
200 - Respuesta exitosa
401 - Unauthorized
401 - Unauthorized
422 - Unprocessable Entity
422 - Unprocessable Entity
429 - Too Many Requests
429 - Too Many Requests
500 - Internal Server Error
500 - Internal Server Error
Detalle de la respuesta
Objeto results
| Campo | Tipo | Descripción |
|---|---|---|
| _id | string | Identificador único de la conversación. |
| operator | object | Información del operador que atendió la conversación (names). |
| user | object | Información del usuario (id). |
| bot | object | Información del bot asociado (name). |
| company | object | Información de la empresa (id). |
| assignationMethod | object | Método de asignación y equipo (teamName). |
| state | string | Estado de la conversación: active, closed, resolved, expired. |
| endedReason | string | Motivo por el cual terminó la conversación. |
| startAt | string | Fecha y hora de inicio de la conversación. |
| endAt | string | Fecha y hora de finalización de la conversación. |
| origin | string | Fuente de la conversación (ej: ticket). |
| timeRepliedOperator | number | Tiempo de respuesta del operador en milisegundos. |
| conversationDuration | number | Duración total de la conversación en milisegundos. |
Objeto pagination
| Campo | Tipo | Descripción |
|---|---|---|
| limit | integer | Conversaciones retornadas por página. |
| total | integer | Total de conversaciones que cumplen con los filtros. |
| offset | integer | Conversaciones omitidas según la página solicitada. |
| totalPages | integer | Cantidad total de páginas disponibles. |
Objeto links
| Campo | Tipo | Descripción |
|---|---|---|
| number | integer | Número de página. |
| url | string | URL relativa para acceder a esa página. |