Obtener el historial del chat

Este método permite obtener una lista de mensajes de un chat específico.

🚧

Ten en cuenta que no podrás ejecutar este paso directamente en la sección de Referencia de la API debido a limitaciones de la herramienta: no es posible calcular los encabezados requeridos y enviar una solicitud al mismo tiempo.

Encabezados y tipo de autorización

ParámetroTipo de datoDescripción
DatestringFecha y hora en que se generó la solicitud. La firma será válida durante 15 minutos a partir de esta fecha. La fecha debe estar en el formato “Thu, 01 Jan 2023 12:00:00 +0000” (RFC2822).
Content-typestringTipo de datos de la solicitud. Actualmente, solo se admite application/json.
Content-MD5stringPara el cuerpo de la solicitud, es necesario calcular el hash MD5 e indicarlo en el encabezado en minúsculas. Al mismo tiempo, es importante tener en cuenta que el cuerpo de la solicitud se calcula como un flujo de bytes sin considerar el final de la marca de JSON, y si hay \n o espacios al final, también se tomarán en cuenta. Para las solicitudes GET, también se debe calcular MD5. Incluso si no se pasa nada en el cuerpo de la solicitud, MD5 se obtendrá de una cadena vacía.
X-SignaturestringFirma de la solicitud como una cadena. Se forma a partir del nombre del método (GET/POST) en mayúsculas, con los valores de los encabezados concatenados por \n. Los valores de los encabezados deben seguir un orden específico. Si no hay encabezado, se debe especificar una cadena vacía en su lugar. Luego, añade el camino solicitado de la URL sin el protocolo y dominio (sin los parámetros GET) a la línea. La cadena resultante se calcula utilizando HMAC-SHA1, y como secreto, se utiliza el secreto del canal obtenido durante el registro. El hash resultante en minúsculas se indica en el encabezado X-Signature.

Encabezado de tipo de datos cuando la solicitud es exitosa/en caso de un error
Content-Type: application/json.

Parámetros de respuesta

ParámetroTipo de datoDescripción
timestampintMarca de tiempo cuando se envió el mensaje.
msec_timestampintMarca de tiempo cuando se envió el mensaje, en milisegundos.
sender[id]stringID del remitente del mensaje en la API de Chats.
sender[name]stringNombre del remitente del mensaje en la API de Chats.
sender[client_id]stringID del remitente del mensaje en el lado de la integración.
sender[avatar]stringAvatar del remitente, si fue proporcionado durante la creación.
sender[phone]stringNúmero de teléfono del remitente, si fue proporcionado durante la creación.
sender[email]stringRemitente, si fue proporcionado durante la creación.
receiver[id]stringID del destinatario del mensaje en la API de Chats.
receiver[name]stringNombre del destinatario del mensaje en la API de Chats.
receiver[client_id]stringID del destinatario del mensaje en el lado de la integración.
receiver[avatar]stringEnlace al avatar del destinatario, si fue proporcionado durante la creación.
receiver[phone]stringNúmero de teléfono del destinatario, si fue proporcionado durante la creación.
receiver[email]stringCorreo del destinatario, si fue proporcionado durante la creación.
message[id]stringID del chat en el lado de la API de Chats.
message[client_id]stringID del chat en el lado de la integración.
message[type]stringTipo de mensaje.
message[text]stringTipo de texto.
message[media]stringEnlace al archivo multimedia.
message[thumbnail]stringEnlace a la miniatura del archivo multimedia.
message[file_name]stringNombre del archivo del campo “media”.
message[file_size]stringTamaño del archivo del campo “media”.
message[media_group_id]stringID del grupo multimedia. Si el usuario envía un solo mensaje con varios adjuntos, lo dividiremos en varios mensajes, pero los archivos multimedia se combinarán en un solo grupo.
message[location]objObjeto de datos de geolocalización
message[location][lon]floatLongitud
message[location][lat]floatLatitud
message[contact]objObjeto de datos de contacto
message[contact][name]stringNombre del contacto
message[contact][phone]stringNúmero de teléfono de contacto
Path Params
string
required

Puedes obtener el scope_id al conectar un canal de chat a la cuenta: https://es-developers.kommo.com/reference/paso-2-conectar-canal-de-chat

string
required

conversation_id puede obtenerse al crear un chat mediante el método de creación de chat, o a través del webhook de mensajes

Query Params
int32

Offset de la selección de mensajes (cuántos registros desde el inicio se omiten)

int32

Cantidad de entidades retornadas por consulta (máximo: 50)

Headers
string
required

Fecha y hora en que se generó la solicitud. La firma será válida por 15 minutos a partir de esta fecha. La fecha debe estar en el formato “Thu, 01 Jan 2023 12:00:00 +0000” (RFC2822)

string

Para el cuerpo de la solicitud, es necesario calcular el hash MD5 e indicarlo en el encabezado en minúsculas. Al mismo tiempo, es importante tener en cuenta que el cuerpo de la solicitud se calcula como un flujo de bytes, sin considerar el cierre del marcado JSON. Si hay "\n" o espacios al final, también se tomarán en cuenta. Para solicitudes GET, también se debe calcular el MD5. Incluso si no se envía nada en el cuerpo de la solicitud, el MD5 se obtendrá de una cadena vacía

string

Firma de la solicitud como una cadena de texto. Se forma a partir del nombre del método (GET/POST) en mayúsculas, con los valores de los encabezados concatenados mediante "\n". Los valores de los encabezados deben ir en un orden específico. Si un encabezado no está presente, se especifica una cadena vacía en su lugar. Luego, se añade a la línea la ruta solicitada desde la URL sin el protocolo ni el dominio (y sin los parámetros GET). La cadena resultante se calcula utilizando HMAC-SHA1 y, como clave secreta, se utiliza el secreto del canal obtenido durante el registro. El hash resultante en minúsculas se indica en el encabezado "X-Signature"

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json