Webhook para mensagens de Texto e Link Renderizado
Descrição:
O evento messages.upsert
é acionado sempre que uma mensagem de texto é inserida ou atualizada. Este webhook é crucial para desenvolvedores e empresas que precisam de informações detalhadas sobre mensagens recebidas em tempo real, sejam elas mensagens de texto simples ou mensagens de texto com links renderizados.
Payload do Webhook:
Texto Simples:
Quando uma mensagem de texto simples é recebida, o payload enviado ao endpoint do webhook configurado será semelhante ao abaixo:
{
"eventType": "messages.upsert",
"instance": "ID_DA_INSTANCIA",
"sender": "NUMERO_DO_REMETENTE@s.whatsapp.net",
"recipient": "NUMERO_DO_DESTINATARIO@s.whatsapp.net",
"messageType": "conversation",
"messageTimestamp": TIMESTAMP,
"pushName": "NOME_PUSH",
"fromMe": BOOLEAN,
"messageContent": "CONTEUDO_DA_MENSAGEM"
}
Texto com Link Renderizado:
Quando uma mensagem contendo um link renderizado é recebida, o payload terá propriedades adicionais relacionadas ao link, como descrito abaixo:
{
"eventType": "messages.upsert",
"instance": "ID_DA_INSTANCIA",
"sender": "NUMERO_DO_REMETENTE@s.whatsapp.net",
"recipient": "NUMERO_DO_DESTINATARIO@s.whatsapp.net",
"messageType": "extendedTextMessage",
"messageTimestamp": TIMESTAMP,
"pushName": "NOME_PUSH",
"fromMe": BOOLEAN,
"messageContent": "CONTEUDO_DA_MENSAGEM_COM_LINK",
"description": "DESCRICAO_DO_LINK",
"title": "TITULO_DO_LINK",
"jpegThumbnail": "MINIATURA_DO_LINK"
}
Detalhamento das Propriedades do Payload:
- eventType: (string) Tipo do evento. Será sempre
messages.upsert
para este webhook. - instance: (string) ID da instância que está enviando ou recebendo a mensagem.
- sender: (string) Número de telefone do remetente no formato internacional, seguido por
@s.whatsapp.net
. - recipient: (string) Número de telefone do destinatário no formato internacional, seguido por
@s.whatsapp.net
. - messageType: (string) Tipo da mensagem. Pode ser
conversation
para mensagens de texto simples ouextendedTextMessage
para mensagens com links renderizados. - messageTimestamp: (number) Timestamp da data e hora da inserção ou atualização da mensagem.
- pushName: (string) Nome exibido do remetente da mensagem.
- fromMe: (boolean)
true
se a mensagem foi enviada pela instância,false
se foi recebida por ela. - messageContent: (string) Conteúdo da mensagem, podendo conter texto e/ou link.
- description, title, jpegThumbnail: (string) Propriedades presentes em mensagens com links renderizados, fornecendo detalhes adicionais sobre o link.
Conclusão
O webhook messages.upsert
oferece uma forma robusta e eficiente de monitorar mensagens de texto, sejam elas simples ou com links renderizados, permitindo assim uma gestão de comunicação otimizada e em tempo real. Se houver questões ou problemas, não hesite em contactar nosso suporte.