Skip to main content

Conceito

O grupo Messages oferece acesso direto a mensagens individuais pelo seu identificador único — sem precisar saber a qual conversa pertencem. Esses endpoints são úteis em cenários onde você já tem o message_id em mãos (por exemplo, recebido via webhook) e precisa buscar os detalhes completos ou remover a mensagem. Para listar mensagens dentro do contexto de uma conversa específica, use os endpoints do grupo Conversations ou Chats, que oferecem paginação e filtros por conversa.

Estrutura de uma mensagem

Uma mensagem na Timely.ai representa qualquer unidade de comunicação trocada em uma conversa: texto, imagem, áudio, vídeo, documento ou mensagem interativa (botões, listas). Cada mensagem registra o remetente (contato, agente IA ou humano), o canal de origem, o status de entrega e os metadados da plataforma (como o wamid do WhatsApp ou o message_id do Telegram).

Campos principais

CampoTipoDescrição
idstring (UUID)ID único da mensagem na Timely
conversation_idstring (UUID)Conversa à qual pertence
channel_idstring (UUID)Canal pelo qual foi enviada/recebida
contentstringConteúdo textual da mensagem
typeenumtext | image | audio | video | document | interactive
directionenuminbound (cliente → agente) | outbound (agente → cliente)
sender_typeenumcontact | agent | human
sender_idstring (UUID)ID do remetente
statusenumsent | delivered | read | failed
media_urlstringURL da mídia (para mensagens com anexo)
external_idstringID externo da mensagem na plataforma de origem
metadataobjectDados adicionais da plataforma (wamid, etc.)
created_atstringISO 8601 de criação

Quando usar Messages vs Conversations vs Chats

CenárioGrupo recomendado
Buscar uma mensagem específica por IDMessages
Listar todo o histórico de uma conversaConversations
Enviar mensagem como atendente humanoChats
Analisar conversas em bulkConversations
Reagir a um evento de webhook com message_idMessages

Endpoints disponíveis

Consulte a barra lateral à esquerda para a lista completa de endpoints deste grupo. Cada endpoint tem sua própria página com schema de request/response, exemplos em cURL/JS/Python e playground interativo.

Próximos passos

Primeira requisição

Se você ainda não fez sua primeira chamada, comece por aqui.