Skip to main content

Webhook para Mensagens de Contato

Descrição:​

O evento messages.upsert é ativado sempre que uma mensagem de contato é inserida ou atualizada. Este webhook é vital para empresas e desenvolvedores que necessitam acompanhar o envio e recebimento de informações de contato em tempo real.

Payload do Webhook:​

Mensagem com Um Contato:​

Quando uma mensagem com um contato é recebida, o payload enviado ao endpoint do webhook configurado será o seguinte:

{
  "eventType": "messages.upsert",
  "instance": "123456789abcdef123456789abcdef12",
  "sender": "123456789012@s.whatsapp.net",
  "recipient": "210987654321@s.whatsapp.net",
  "messageType": "contactMessage",
  "owner": "123456789abcdef123456789abcdef12",
  "messageTimestamp": 1696093248,
  "pushName": "Carlos",
  "fromMe": false,
  "contact": {
    "displayName": "João Silva",
    "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Silva;João;;;\nFN:João Silva\nTEL;type=CELL;type=VOICE;waid=123456789012:+1 234-567-8901\nEND:VCARD"
  }
}

Mensagem com Múltiplos Contatos:​

Quando uma mensagem com mais de um contato é recebida, o payload enviado será:

{
  "eventType": "messages.upsert",
  "instance": "123456789abcdef123456789abcdef12",
  "sender": "123456789012@s.whatsapp.net",
  "recipient": "210987654321@s.whatsapp.net",
  "messageType": "contactsArrayMessage",
  "owner": "123456789abcdef123456789abcdef12",
  "messageTimestamp": 1696093197,
  "pushName": "Carlos",
  "fromMe": false,
  "contacts": [
    {
      "displayName": "Maria Oliveira",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Oliveira;Maria;;;\nFN:Maria Oliveira\nORG:Empresa XYZ;\nTEL;type=CELL;type=VOICE;waid=210987654321:+2 109-876-5432\nEND:VCARD"
    },
    {
      "displayName": "Roberto Souza",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Souza;Roberto;;;\nFN:Roberto Souza\nORG:Empresa ABC;\nTEL;type=CELL;type=VOICE;waid=321098765432:+3 210-987-6543\nEND:VCARD"
    }
  ]
}

Detalhamento das Propriedades do Payload:​

O detalhamento de propriedades é similar ao de uma mensagem de localização, mudando o messageType e as informações de contato:

  • messageType: (string) Será contactMessage para mensagens que contenham um contato e contactsArrayMessage para aquelas que contenham múltiplos contatos.
  • contact/contacts: (objeto/array) Contêm as informações do(s) contato(s) recebido(s), incluindo o nome para exibição e o vCard.

Propriedades dos Objetos contact e contacts:​

  • displayName: (string) Nome para exibição do contato.
  • vcard: (string) Informações do contato em formato vCard, incluindo nome, número de telefone, nome da empresa, etc.

Conclusão​

O webhook messages.upsert para mensagens de contato permite o monitoramento eficiente em tempo real de informações de contato transmitidas, assegurando uma integração detalhada e eficiente para desenvolvedores e empresas. Se houverem dúvidas ou questões adicionais, por favor, entre em contato com nosso suporte.