Obter histórico de chat

get https://amojo.kommo.com/v2/origin/custom/{scope_id}/chats/{conversation_id}/history

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

🚧
Esteja ciente de que você não poderá executar esta etapa descrita acima diretamente na seção de Referência da API devido a limitações da ferramenta: não é possível calcular os cabeçalhos necessários e enviar uma solicitação simultaneamente.

Cabeçalhos e tipo de autorização

Parâmetro	Tipo de dado	Descrição
Date	string	Data e hora em que a solicitação foi gerada. A assinatura será válida por 15 minutos a partir dessa data. A data deve estar no formato “Thu, 01 Jan 2023 12:00:00 +0000” (RFC2822).
Content-type	string	Tipo de dados da solicitação. Atualmente, apenas application/json é suportado.
Content-MD5	string	Para o corpo da solicitação, é necessário calcular o hash MD5 e indicá-lo no cabeçalho em letras minúsculas. Ao mesmo tempo, é 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 levados em conta.
X-Signature	string	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 são organizados em uma ordem específica. Se não houver cabeçalho, uma string vazia é especificada em seu lugar. Em seguida, adicione o caminho solicitado da URL sem o protocolo e o domínio (sem parâmetros GET) à string. A string resultante é calculada usando HMAC-SHA1 e, como segredo, utilizamos a chave secreta do canal obtida durante o registro. O hash resultante, em letras minúsculas, é indicado no cabeçalho X-Signature.

🦉

Calculate headers for Chats API requests

Open Recipe

Cabeçalho de tipo de dado quando a solicitação é bem-sucedida
Content-Type: application/hal+json

Parâmetros de resposta

Parâmetro	Tipo de dado	Descrição
timestamp	int	Carimbo de data/hora quando a mensagem foi enviada
msec_timestamp	int	Carimbo de data/hora quando a mensagem foi enviada em milissegundos
sender[id]	string	ID do remetente da mensagem na API de Chats
sender[name]	string	Nome do remetente da mensagem na API de Chats
sender[client_id]	string	ID do remetente da mensagem no lado da integração
sender[avatar]	string	Avatar do remetente, se foi passado durante a criação
sender[phone]	string	Número de telefone do remetente, se foi informado durante a criação
sender[email]	string	E-mail do remetente, se foi enviado durante a criação
receiver[id]	string	ID do destinatário da mensagem na API de Chats
receiver[name]	string	Nome do destinatário da mensagem na API de Chats
receiver[client_id]	string	ID do destinatário da mensagem no lado da integração
receiver[avatar]	string	Link para o avatar do destinatário, se foi passado durante a criação
receiver[phone]	string	Número de telefone do destinatário, se foi informado durante a criação
receiver[email]	string	E-mail do destinatário, se foi enviado durante a criação
message[id]	string	ID do chat no lado da API de Chats
message[client_id]	string	ID do chat no lado da integração
message[type]	string	Tipo de mensagem
message[text]	string	Texto da mensagem
message[media]	string	Link para o arquivo de mídia
message[thumbnail]	string	Link para a miniatura da mídia
message[file_name]	string	Nome do arquivo do campo “media”
message[file_size]	string	Tamanho do arquivo do campo “media”
message[media_group_id]	string	ID do grupo de mídia. Se o usuário enviar uma única mensagem com vários anexos, ela será dividida em várias mensagens, mas os arquivos de mídia serão combinados em um grupo.

Path Params

scope_id

string

required

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

conversation_id

string

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 Params

offset

int32

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

limit

int32

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

Headers

Date

string

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-type

string

required

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

Content-MD5

string

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-Signature

string

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.

Responses

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://amojo.kommo.com/v2/origin/custom/scope_id/chats/conversation_id/history \
3
     --header 'accept: application/json'

Choose an example:

application/json

🚧

Cabeçalhos e tipo de autorização

Parâmetros de resposta

200200

204204

400400

403403