Obtener mensajes de una conversación

El método permite recuperar los mensajes de una conversación.

Limitaciones

  • El método está disponible de acuerdo con los permisos del usuario.
  • El método está disponible para los planes de Prueba, Pro, Empresarial y Técnico.
  • El método requiere el alcance de intregación Historial de chats externos.

Encabezado del tipo de datos cuando la solicitud se realiza correctamente
Content-Type: application/hal+json

Encabezado del tipo de datos en caso de error
Content-Type: application/problem+json

Parámetros de respuesta

ParámetroTipo de datoDescripción
idstringID del mensaje.
chat_idstringID del chat.
typestringDirección del mensaje. Valores posibles: incoming, outgoing.
message_typestringTipo de contenido del mensaje. Valores posibles: text, contact, file, video, picture, voice, audio, sticker, location.
authorobjObjeto del autor del mensaje.
author[id]stringID del autor.
author[type]stringTipo de autor. Valores posibles: internal (usuario de Kommo), external (cliente), bot (bot de Kommo).
author[name]stringNombre para mostrar del autor.
author[avatar_url]stringURL del avatar del autor.
author[user_id]intID del usuario de Kommo. Solo se retorna cuando author[type]: internal.
recipientobjObjeto del destinatario del mensaje.
recipient[id]stringID del destinatario.
recipient[type]string | nullTipo de destinatario. Valores posibles: external (client).
recipient[name]stringNombre para mostrar del destinatario.
recipient[avatar_url]stringURL del avatar del destinatario.
textstringTexto del mensaje. Vacío para los mensajes sin contenido de texto.
created_atintHora de creación del mensaje como Unix Timestamp (segundos).
sec_created_atintHora de creación del mensaje como Unix Timestamp (milisegundos).
originstringCanal de chat del mensaje.
delivery_statusstringEstado de entrega del mensaje. Valores posibles: sent, delivered, error.
attachmentobj | nullObjeto del archivo adjunto.
attachment[type]stringTipo de archivo adjunto.
attachment[link]stringRuta o URL del archivo adjunto.
attachment[file_name]stringNombre del archivo adjunto.

Path Params
integer
required

ID de la conversación

Query Params
integer

Página de resultados

integer

Cantidad de entidades retornadas por solicitud (límite: 250)

integer

Filtra por la fecha de envío del mensaje en formato Unix Timestamp. Retorna los mensajes enviados desde esta fecha.

integer

Filtra por la fecha de envío del mensaje en formato Unix Timestamp. Retorna los mensajes enviados hasta esta fecha.

Headers
string
enum
Defaults to application/hal+json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
application/problem+json