Ir para o conteúdo

Mensagem de entrada com um array de contatos#

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

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

typeWebhook = incomingMessageReceived

messageData.typeMessage = contactsArrayMessage

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 contactsArrayMessage
contacts object Objeto de array de dados sobre os contatos recebidos.
quotedMessage object Objeto de dados sobre a mensagem citada. Está presente apenas se a própria mensagem é uma citação
isForwarded boolean A mensagem é encaminhada, assume valores true/false
forwardingScore integer Quantidade de encaminhamentos da mensagem

Campos do objeto contacts

Parâmetro Tipo Descrição
displayName string Nome de exibição do contato
vcard string Estrutura VCard (cartão de visita do contato)

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"
  },
  "typeMessage": "ContactsArrayMessage",
  "contacts":  [
        {
            "displayName": "Victor Andrade",
            "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Andrade;Victor;;;\nFN:Victor Andrade\nORG:Image\nTITLE:\nitem1.TEL;waid=79001234569:+55 900 123-45-69\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        },
        {
            "displayName": "Antonio Pedrosovich",
            "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Pedrosovich;Oleg;;;\nFN:Antonio Pedrosovich\nORG:Image\nTITLE:\nitem1.TEL;waid=79001234569:+55 900 123-45-69\nitem1.X-ABLabel:Мобильный\nEND:VCARD"
        }
  ],
  "forwardingScore": 4,
  "isForwarded": true
  }
}

Exemplo de corpo de notificação de mensagem recebida com array de contatos e citação de mensagem de texto#

{
  "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": "ContactsArrayMessage",
    "contacts":  [
        {
            "displayName": "Victor Andrade",
            "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Andrade;Victor;;;\nFN:Victor Andrade\nORG:Image\nTITLE:\nitem1.TEL;waid=79001234569:+55 900 123-45-69\nitem1.X-ABLabel:Móvel\nEND:VCARD"
        },
        {
            "displayName": "Oleg Pedrosovich",
            "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Pedrosovich;Oleg;;;\nFN:Oleg Pedrosovich\nORG:Image\nTITLE:\nitem1.TEL;waid=79001234569:+55 900 123-45-69\nitem1.X-ABLabel:Móvel\nEND:VCARD"
        }
    ],
    "forwardingScore": 4,
    "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "9A73322488DCB7D9689A6112F2528C9D",
      "participant": "79001235696@c.us",
      "typeMessage": "textMessage",
      "textMessage": "Oi"
    }
  }
}

Exemplo de corpo de notificação de mensagem recebida com array de contatos 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"
  },
    "typeMessage": "ContactsArrayMessage",
    "contacts":  [
        {
            "displayName": "Victor Andrade",
            "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Andrade;Victor;;;\nFN:Victor Andrade\nORG:Image\nTITLE:\nitem1.TEL;waid=79001234569:+55 900 123-45-69\nitem1.X-ABLabel:Móvel\nEND:VCARD"
        },
        {
            "displayName": "Oleg Pedrosovich",
            "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Pedrosovich;Oleg;;;\nFN:Oleg Pedrosovich\nORG:Image\nTITLE:\nitem1.TEL;waid=79001234569:+55 900 123-45-69\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 mensagem recebida com array de contatos e citação de contato#

{
  "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"
  },
    "typeMessage": "ContactsArrayMessage",
    "contacts":  [
        {
            "displayName": "Victor Andrade",
            "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Andrade;Victor;;;\nFN:Victor Andrade\nORG:Image\nTITLE:\nitem1.TEL;waid=79001234569:+55 900 123-45-69\nitem1.X-ABLabel:Móvel\nEND:VCARD"
        },
        {
            "displayName": "Oleg Pedrosovich",
            "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Pedrosovich;Oleg;;;\nFN:Oleg Pedrosovich\nORG:Image\nTITLE:\nitem1.TEL;waid=79001234569:+55 900 123-45-69\nitem1.X-ABLabel:Móvel\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:+55 900 123-00-00\nitem1.X-ABLabel:Móvel\nEND:VCARD"
      }
    }
  }
}

Exemplo de corpo de notificação de mensagem recebida com array de contatos e citação de geolocalizaçã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"
  },
    "typeMessage": "ContactsArrayMessage",
    "contacts":  [
        {
            "displayName": "Victor Andrade",
            "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Andrade;Victor;;;\nFN:Victor Andrade\nORG:Image\nTITLE:\nitem1.TEL;waid=79001234569:+55 900 123-45-69\nitem1.X-ABLabel:Móvel\nEND:VCARD"
        },
        {
            "displayName": "Oleg Pedrosovich",
            "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Pedrosovich;Oleg;;;\nFN:Oleg Pedrosovich\nORG:Image\nTITLE:\nitem1.TEL;waid=79001234569:+55 900 123-45-69\nitem1.X-ABLabel:Móvel\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
      }
    }
  }
}