v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB

conversas-v2-messages

Listar histórico de conversas

ℹ️ API disponível apenas para o plano Advanced.

ℹ️ Este recurso requer criptografia.

Listar histórico de conversas.

Paginação: por offset (parâmetros page e limit). Não há cursor. O limite máximo por requisição é 100 registros. Se limit for informado e ≤ 100, usa esse valor; caso contrário o padrão é 15.

Para obter as próximas páginas, incremente o parâmetro page (ex.: page=1, page=2, page=3) e mantenha o mesmo limit. Exemplo: limit=50&page=2 retorna os registros de 51 a 100.

get/v2/messages/history

Query parameters

limitinteger

Número de registros por página (máximo 100; padrão 15).

pageinteger

Número da página da listagem.

channelstring[]

Canal de comunicação.

[
  "telegram",
  "whatsapp"
]

customer_idstring hash required

Example:507f191e810c19729de860ea

ID do contato que deseja retornar as mensagens.

end_datestring date

Example:2025-04-01

Data final do período a ser pesquisado.

sent_bystring[]

Filtro por remetente (customer, operator, bot).

[
  "customer",
  "operator"
]

start_datestring date

Example:2025-03-30

Data inicial do período a ser pesquisado.

typestring[]

Filtro por tipo de mensagem.

[
  "image",
  "text"
]

Response

Histórico de mensagens (criptografado)

messagesstring required

Lista criptografada com as mensagens do contato.