Obter mensagens de uma conversa

Este método permite obter as mensagens de uma conversa.

Limitações

  • O método está disponível de acordo com as permissões/direitos do usuário.
  • O método está disponível para contas nos planos: Teste, Pro, Empresarial e Técnico.
  • O método requer o escopo de integração Histórico de chats externos

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

Cabeçalho do tipo de dados no caso de erro
Content-Type: application/problem+json

Parâmetros de resposta

ParâmetroTipo de dadoDescrição
idstringID da mensagem
chat_idstringID do chat
typestringDireção da mensagem. Valores possíveis: incoming, outgoing
message_typestringTipo de conteúdo da mensagem. Valores possíveis: text, contact, file, video, picture, voice, audio, sticker, location
authorobjObjeto do autor da mensagem
author[id]stringID do autor
author[type]stringTipo de autor. Valores possíveis: internal (Usuário Kommo), external (Cliente), bot (Bot da Kommo)
author[name]stringNome de exibição do autor
author[avatar_url]stringURL do avatar do autor
author[user_id]intID do usuário da Kommo. Será retornado somente quando author[type]: internal
recipientobjObjeto do destinatário da mensagem
recipient[id]stringID do destinatário
recipient[type]string | nullTipo de destinatário. Valores possíveis: external (Cliente)
recipient[name]stringNome de exibição do destinatário
recipient[avatar_url]stringURL do avatar do destinatário
textstringTexto da mensagem. Vazio em caso de mensagens sem texto content
created_atintMomento da criação da mensagem no formato Unix Timestamp (segundos)
sec_created_atintMomento da criação da mensagem no formato Unix Timestamp (milissegundos)
originstringCanal de chat da mensagem.
delivery_statusstringStatus de entrega da mensagem. Valores possíveis: sent, delivered, error
attachmentobj | nullObjeto anexado
attachment[type]stringTipo de anexo
attachment[link]stringURL ou caminho do arquivo anexado
attachment[file_name]stringNome do arquivo anexado

Path Params
integer
required

ID da conversa

Query Params
integer

Página de resposta

integer

Número de entidades retornadas por requisição (limite – 250)

integer

Filtro pela data da mensagem enviada no formato Unix Timestamp. Filtra mensagens à partir desta data.

integer

Filtro pela data da mensagem enviada no formato Unix Timestamp. Filtra mensagens até esta data.

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