Obter histórico de chat

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âmetroTipo de dadoDescrição
DatestringData 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-typestringTipo de dados da solicitação. Atualmente, apenas application/json é suportado.
Content-MD5stringPara 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-SignaturestringAssinatura 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.

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

Parâmetros de resposta

ParâmetroTipo de dadoDescrição
timestampintCarimbo de data/hora quando a mensagem foi enviada
msec_timestampintCarimbo de data/hora quando a mensagem foi enviada em milissegundos
sender[id]stringID do remetente da mensagem na API de Chats
sender[name]stringNome do remetente da mensagem na API de Chats
sender[client_id]stringID do remetente da mensagem no lado da integração
sender[avatar]stringAvatar do remetente, se foi passado durante a criação
sender[phone]stringNúmero de telefone do remetente, se foi informado durante a criação
sender[email]stringE-mail do remetente, se foi enviado durante a criação
receiver[id]stringID do destinatário da mensagem na API de Chats
receiver[name]stringNome do destinatário da mensagem na API de Chats
receiver[client_id]stringID do destinatário da mensagem no lado da integração
receiver[avatar]stringLink para o avatar do destinatário, se foi passado durante a criação
receiver[phone]stringNúmero de telefone do destinatário, se foi informado durante a criação
receiver[email]stringE-mail do destinatário, se foi enviado durante a criação
message[id]stringID do chat no lado da API de Chats
message[client_id]stringID do chat no lado da integração
message[type]stringTipo de mensagem
message[text]stringTexto da mensagem
message[media]stringLink para o arquivo de mídia
message[thumbnail]stringLink para a miniatura da mídia
message[file_name]stringNome do arquivo do campo “media”
message[file_size]stringTamanho do arquivo do campo “media”
message[media_group_id]stringID 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.
Language