v1

latestOpenAPI 3.1.02026-07-261620662.2 KB

Obter histórico de chat

O método permite obter uma lista de mensagens em um chat específico.

get/{scope_id}/chats/{conversation_id}/history

Path parameters

scope_idstring required

ID do escopo, específico para sua integração

conversation_idstring required

O conversation_id pode ser obtido ao criar um chat por meio do método de criação de chat ou pelo webhook da mensagem.

Query parameters

offsetinteger

Deslocamento da seleção de mensagens (quantos registros desde o início da seleção serão ignorados)

limitinteger

Número de entidades retornadas por consulta (Máximo – 50)

Headers

Datestring required

Data e hora em que a solicitação foi gerada. A assinatura será válida por 15 minutos a partir dessa data. O formato deve ser “Thu, 01 Jan 2023 12:00:00 +0000” (RFC2822)

Content-typestring required

Tipo de dados da solicitação. Atualmente, apenas application/json é suportado.

Content-MD5string

Para o corpo da solicitação, é necessário calcular o hash MD5 e indicá-lo no cabeçalho em letras minúsculas. É importante lembrar que o corpo da solicitação é calculado como um fluxo de bytes sem considerar o final da marcação JSON, e se houver “\n” ou espaços no final, eles também serão considerados. Para solicitações GET, o MD5 também deve ser calculado. Mesmo que nada seja passado no corpo da solicitação, o MD5 será obtido de uma string vazia.

X-Signaturestring

Assinatura da solicitação como uma string. Ela é formada a partir do nome do método (GET/POST) em maiúsculas, com os valores dos cabeçalhos concatenados por “\n”. Os valores dos cabeçalhos vêm em uma ordem específica. Se não houver cabeçalho, uma string vazia é especificada. Em seguida, adicione o caminho solicitado da URL sem o protocolo e o domínio (sem parâmetros GET) à linha. A string resultante é calculada usando HMAC-SHA1, e como segredo, usamos a chave secreta do canal obtida durante o registro. O hash resultante em letras minúsculas é indicado no cabeçalho X-Signature.

Response

200

Example response

{
  "messages": [
    {
      "timestamp": 1670930693,
      "msec_timestamp": 1670930693280,
      "sender": {
        "id": "XXXXXX-ec21-4463-965f-1fe1d4cd5b89",
        "name": "Judite"
      },
      "receiver": {
        "id": "XXXXXXX-a3ab-4695-832c-919dbfc598ea",
        "client_id": "XXXXXXXXX-ec21-4463-965f-1fe1d4cd5a89",
        "name": "Adam",
        "avatar": "https://www.w3schools.com/w3images/avatar2.png",
        "phone": "+1234567890"
      },
      "message": {
        "id": "XXXXXXX-de79-468b-a923-9a7c88c733d7",
        "type": "picture",
        "text": "Olá da Kommo",
        "media": "https://amojo.kommo.com/attachments/XXXXXXX-d2eb-4bd8-b862-a67934927b38/14723c64-c40d-4efc-9f78-9625adac414c/zDCRN_logo-min.jpg",
        "thumbnail": "https://amojo.kommo.com/attachments/XXXXXXX-d2eb-4bd8-b862-a67934927b38/14723c64-c40d-4efc-9f78-9625adac414c/zDCRN_logo-min_320x200.jpg",
        "file_name": "logo-min.png",
        "file_size": 27107
      }
    }
  ]
}