Ir para o conteúdo

Входящее сообщение с контактом#

Nesta seção, descrevemos o formato da notificação de entrada do objeto messageData para a mensagem de entrada com contato. Para obter uma descrição do formato geral das notificações de entrada, consulte a seção Mensagens Recebidas.

Para receber notificações de entrada desse tipo, duas condições devem ser atendidas:

typeWebhook = incomingMessageReceived

messageData.typeMessage = contactMessage

Notificação#

Formato de notificação#

Campos do objeto messageData

Parâmetro Tipo Descrição
typeMessage string Tipo de mensagem recebida. Para mensagens deste tipo, o campo assume o valor contactMessage
contactMessageData object Objeto de dados do contato recebido.
quotedMessage object Objeto de dados da mensagem citada. Presente apenas se a mensagem for uma citação

Campos do objeto contactMessageData

Parâmetro Tipo Descrição
displayName string Nome exibido do contato
vcard string Estrutura do VCard (cartão de visita do contato)
isForwarded boolean A mensagem foi encaminhada? Assumindo os valores verdadeiro/falso
forwardingScore integer Número de encaminhamentos da mensagem

Campos do objeto quotedMessage

Parâmetro Tipo Descrição
stanzaId string id da mensagem citada
participant string id do remetente da mensagem citada
typeMessage string Tipo da mensagem citada

Os outros campos são preenchidos dependendo do tipo da mensagem citada e são idênticos aos campos das mensagens de entrada descritas na seção Mensagens Recebidas

Exemplo de corpo de notificação#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234568@c.us",
    "sender": "79001234568@c.us",
      "chatName": "Green API",
    "senderName": "Green API"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "Victor André",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:André;Victor;;;\nFN:Victor André\nORG:Imagem\nTITLE:\nitem1.TEL;waid=79001234569:+7 900 123-45-69\nitem1.X-ABLabel:Móvel\nEND:VCARD",
        "forwardingScore": 4,
      "isForwarded": true
    }
  }
}

Exemplo de corpo de notificação de uma mensagem de entrada com contato e citação de mensagem de texto{#webhook-example-body}#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234568@c.us",
    "sender": "79001234568@c.us",
      "chatName": "Green API",
    "senderName": "Green API"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "AntiSpam",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:;AntiSpam;;;\nFN:AntiSpam\nitem1.TEL:*9035936232#\nitem1.X-ABLabel:Móvel\nEND:VCARD",
      "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "9A73322488DCB7D9689A6112F2528C9D",
      "participant": "79001235696@c.us",
      "typeMessage": "textMessage",
      "textMessage": "Olá"
    }
  }
}

Exemplo de corpo de notificação de uma mensagem de entrada com contato e citação de áudio/vídeo/documento#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234568@c.us",
    "sender": "79001234568@c.us",
      "chatName": "Green API",
    "senderName": "Green API"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "AntiSpam",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:2 Lena\nitem1.TEL;waid=79001230000\nitem1.X-ABLabel:Móvel\nEND:VCARD",
      "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "9A73322488DCB7D9689A6112F2528C9D",
      "participant": "79061230000@c.us",
      "typeMessage": "imageMessage",
      "downloadUrl": "",
      "caption": "",
      "jpegThumbnail": ""
    }
  }
}

Exemplo de corpo de notificação de uma mensagem de entrada com contato e citação de contato{#webhook-example-body}#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234568@c.us",
    "sender": "79001234568@c.us",
      "chatName": "Green API",
    "senderName": "Green API"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Fundo;\nitem1.TEL;waid=79001203030:/em1.X-ABLabel:Novo tipo\nEND:VCARD",
      "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "9A73322488DCB7D9689A6112F2528C9D",
      "participant": "79061230000@c.us",
      "typeMessage": "contactMessage",
      "contact": {
        "displayName": "Green-Api",
        "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Green-Api\nitem1.TEL;waid=79001230000\nitem1.X-ABLabel:Móvel\nEND:VCARD"
      }
    }
  }
}

Exemplo de corpo de notificação de uma mensagem de entrada com contato e citação de geolocalização{#webhook-example-body}#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234568@c.us",
    "sender": "79001234568@c.us",
      "chatName": "Green API",
    "senderName": "Green API"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "Fundo",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:2 Corações\nitem1.TEL;waid=79200000102\nitem1.X-ABLabel:Novo tipo\nEND:VCARD",
      "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "9A73322488DCB7D9689A6112F2528C9D",
      "participant": "79060002233@c.us",
      "typeMessage": "locationMessage",
      "location": {
        "nameLocation": "",
        "address": "",
        "jpegThumbnail": "",
        "latitude": 72.5922702,
        "longitude": 45.6645388
      }
    }
  }
}