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 |
|---|---|---|---|---|---|
| startAt | Query | string | Sí | — | Fecha de inicio del rango en formato ISO 8601 (UTC). Ejemplo: 2026-03-10T00:00:00.000Z |
| endAt | Query | string | Sí | — | Fecha de fin del rango en formato ISO 8601 (UTC). Ejemplo: 2026-03-17T23:59:59.999Z |
| limit | Query | integer | No | 10 | Número máximo de conversaciones por página. Máximo: 50. |
| page | Query | integer | No | 1 | Número de página. |
| botId | Query | string | No | — | Filtra conversaciones por el identificador del bot. |
| userId | Query | string | No | — | Filtra conversaciones por el identificador del usuario. |
| operatorId | Query | integer | No | — | Filtra conversaciones por el identificador del operador. |
| conversationId | Query | string | No | — | Filtra por el identificador único de una conversación. |
| state | Query | string | No | — | Filtra por estado de la conversación: active, closed, resolved, expired, transferred. |
Ejemplos de solicitud
- cURL
- JavaScript
Respuestas
200 - Respuesta exitosa
200 - Respuesta exitosa
401 - Unauthorized
401 - Unauthorized
422 - Unprocessable Entity
422 - Unprocessable Entity
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. |
| operator.id | integer | Identificador del operador. |
| operator.names | string | Nombre del operador. |
| operator.email | string | Correo electrónico del operador. |
| user | object | Información del usuario. |
| user.id | string | Identificador del usuario. |
| user.names | string | Nombre del usuario. |
| bot | object | Información del bot asociado. |
| bot.id | string | Identificador del bot. |
| bot.name | string | Nombre del bot. |
| company | object | Información de la empresa. |
| company.name | string | Nombre de la empresa. |
| assignationMethod | object | Método de asignación. |
| assignationMethod.teamName | string | Nombre del equipo al que fue asignada la conversación. |
| state | string | Estado de la conversación: active, closed, resolved, expired, transferred. |
| wasReplied | boolean | Indica si la conversación recibió respuesta del operador. |
| childConversation | string | null | Identificador de la conversación hija en caso de transferencia. |
| parentConversation | string | null | Identificador de la conversación padre si fue recibida por transferencia. |
| endedReason | string | Motivo de cierre: closed_by_operator, expired, transferred, entre otros. |
| startAt | string | Fecha y hora de inicio de la conversación. |
| endAt | string | Fecha y hora de finalización de la conversación. |
| firstRepliedAtOperator | string | null | Fecha y hora de la primera respuesta del operador. |
| origin | string | Origen de la conversación: organic, transfer, induced_by_operator, entre otros. |
| timeRepliedOperator | number | null | Tiempo hasta la primera respuesta del operador en milisegundos. |
| conversationDuration | number | Duración total de la conversación en milisegundos. |
| avgOperatorResponseTime | number | null | Tiempo promedio de respuesta del operador en milisegundos. |