Mensagem de entrada com botões#

Nesta seção, descrevemos o formato da notificação de entrada do objeto messageData para a mensagem de entrada com botões. 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 = buttonsMessage

Notificacã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 buttonsMessage
`buttonsMessage`	object	Objeto de dados com botões
`quotedMessage`	object	Objeto de dados da mensagem citada. Presente apenas se a mensagem for uma citação

Campos do objeto buttonsMessage

Parâmetro	Tipo	Descrição
`contentText`	string	Mensagem de texto do corpo dos botões
`footer`	string	Mensagem de texto do rodapé dos botões
`buttons`	object	Objeto de dados com botões
`isForwarded`	boolean	A mensagem foi encaminhada? Assumindo os valores verdadeiro/falso
`forwardingScore`	integer	Número de encaminhamentos da mensagem

Campos do objeto buttons

Parâmetro	Tipo	Descrição
`buttonId`	string	id do botão
`buttonText`	string	Texto do botão

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": "buttonsMessage",
        "buttonsMessage": {
            "contentText": "Hello",
            "footer": "Hello",
            "buttons": [
                {
                    "buttonId": "1",
                    "buttonText": "green"
                },
                {
                    "buttonId": "2",
                    "buttonText": "red"
                },
                {
                    "buttonId": "3",
                    "buttonText": "blue"
                }
            ],
             "forwardingScore": 4,
             "isForwarded": true
        }
    }
}