Mensagem de entrada com botões de modelo#

Esta seção descreve o formato da notificação de entrada do objeto messageData para mensagens de modelo de entrada com botões. 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 = templateMessage

Notificação#

Formato da notificação#

Campos do objeto messageData

Parâmetro	Tipo	Descrição
`typeMessage`	string	O tipo de mensagem recebida. Para mensagens deste tipo, o campo tem o valor `templateMessage`.
`templateMessage`	object	Objeto de dados com botões
`quotedMessage`	object	Objeto de dados da mensagem citada. Presente apenas se a própria mensagem for uma citação.

Campos do objeto templateMessage

Parâmetro	Tipo	Descrição
`namespace`	string	Namespace da organização
`elementName`	string	Nome da mensagem do modelo
`contentText`	string	Mensagem de texto dos botões
`footer`	string	Mensagem de rodapé dos botões
`buttons`	object	Objeto de dados com botões
`isForwarded`	boolean	Indica se a mensagem foi encaminhada, com os valores true/false
`forwardingScore`	integer	Número de vezes que a mensagem foi encaminhada

Campos do objeto buttons

Parâmetro	Tipo	Descrição
`index`	string	Índice do botão
`urlButton`	object	Objeto de dados do botão de URL
`callButton`	object	Objeto de dados do botão de chamada
`quickReplyButton`	object	Objeto de dados do botão de resposta rápida

Campos do objeto urlButton

Parâmetro	Tipo	Descrição
`displayText`	string	Texto do botão de URL
`url`	string	URL

Campos do objeto callButton

Parâmetro	Tipo	Descrição
`displayText`	string	Texto do botão de chamada
`phoneNumber`	string	Número de telefone

Campos do objeto quickReplyButton

Parâmetro	Tipo	Descrição
`displayText`	string	Texto do botão de resposta rápida
`id`	string	ID do botão de resposta rápida

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 demais campos são preenchidos de acordo com o tipo de mensagem citada e são idênticos aos campos de mensagens de entrada descritos na seção Mensagens de Entrada.

Exemplo de corpo da 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": "templateMessage",
        "templateMessage": {
            "contentText": "Olá",
            "footer": "Olá",
            "buttons": [
                {
                    "urlButton": {
                        "displayText": "⭐ Avalie-nos no GitHub!",
                        "url": "https://github.com/green-api/docs"
                    },
                    "index": 1
                },
                {
                    "callButton": {
                        "displayText": "Ligue para nós",
                        "phoneNumber": "+1 (234) 5678-901"
                    },
                    "index": 2
                },
                {
                    "quickReplyButton": {
                        "displayText": "Olá",
                        "id": "plainButtonId"
                    },
                    "index": 3
                }
            ],
             "forwardingScore": 4,
             "isForwarded": true
        }
    }
}