get
https://{subdominio}.kommo.com/api/v4/talks
Este método retorna una colección de conversaciones de la cuenta.
Limitaciones
Este método está disponible para todos los usuarios de la cuenta. Los datos retornados dependen de los permisos que tenga el usuario sobre el contacto asociado con la conversación.
Tipo de contenido del encabezado cuando la solicitud se realiza correctamente
Content-Type: application/hal+json
Tipo de contenido del encabezado en caso de error
Content-Type: application/problem+json
Parámetros de la respuesta
| Parámetro | Tipo de dato | Descripción |
|---|---|---|
| talk_id | int | ID de la conversación |
| created_at | int | Fecha de creación de la conversación como marca de tiempo Unix. |
| updated_at | int | Fecha de la última actualización de la conversación como marca de tiempo Unix. |
| rate | int | Calificación de la conversación proporcionada por el bot de NPS. |
| contact_id | int | ID del contacto asociado con la conversación. |
| chat_id | string | ID del chat asociado con la conversación. |
| entity_id | int | null | ID de la entidad relacionada con la conversación. |
| entity_type | string | null | Tipo de la entidad relacionada. Valores posibles: lead |
| status | string | Estado de la conversación. Valores posibles: in_work – la conversación está activa, closed – la conversación está cerrada, nps_scheduled – la encuesta de NPS está programada, nps_in_progress – la encuesta de NPS se ha enviado y está pendiente de respuesta, with_error – la conversación está activa, pero ocurrió un error durante el flujo de trabajo del bot de NPS. |
| is_in_work | bool | Indica si la conversación está abierta. |
| is_read | bool | Indica si la conversación ha sido leída. |
| origin | string | Tipo de origen desde el que se creó la conversaciónd (por ejemplo, telegram) |
| source_id | int | null | ID del origen de la conversación. |
| account_id | int | ID de la cuenta. |
| _embedded | object | Datos de las entidades incrustadas. |
| _embedded[contacts] | array | Datos del contacto asociado con la conversación (máximo 1 contacto). |
| _embedded[contacts][0] | object | Objeto del contacto. |
| _embedded[contacts][0][id] | int | ID del contacto. |
| _embedded[leads] | array | Datos del lead asociado con la conversación (máximo 1 lead). |
| _embedded[leads][0] | object | Objeto del lead. |
| _embedded[leads][0][id] | int | ID del lead. |