Mensagem de entrada com lista de opções#

Esta seção descreve o formato da notificação de entrada do objeto messageData para uma mensagem de entrada com uma lista de opções. Para obter uma descrição do formato geral das notificações de entrada, consulte a seção Mensagens de entrada: Webhook-IncomingMessageReceived.md.

Para receber notificações de entrada deste tipo, você deve atender aos dois seguintes critérios:

typeWebhook = incomingMessageReceived

messageData.typeMessage = listMessage

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 `listMessage`.
`listMessage`	objeto	O objeto de dados da lista.
`quotedMessage`	objeto	O objeto de dados da mensagem citada. Presente apenas se a própria mensagem for uma citação.

Campos do objeto listMessage

Parâmetro	Tipo	Descrição
`contentText`	string	A mensagem de texto do corpo do botão.
`title`	string	Não
`footer`	string	A mensagem de texto do rodapé do botão.
`listMessage`	objeto	O objeto de dados dos botões.
`buttonText`	string	Não
`sections`	array	Sim
`isForwarded`	boolean	Se a mensagem foi enviada, tem os valores `true` ou `false`.
`forwardingScore`	inteiro	O número de vezes que a mensagem foi enviada.

Campos do array sections

Parâmetro	Tipo	Descrição
`title`	string	O título da lista de opções.
`rows`	array	Os valores da lista de opções.

Campos do array rows

Parâmetro	Tipo	Descrição
`title`	string	O texto do valor da lista.
`rowId`	string	O ID do valor da lista.
`description`	string	A descrição do valor da lista.

Campos do objeto quotedMessage

Parâmetro	Tipo	Descrição
`stanzaId`	string	O ID da mensagem citada.
`participant`	string	O ID do remetente da mensagem citada.
`typeMessage`	string	O 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 de entrada: Webhook-IncomingMessageReceived.md.

Exemplo do 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": "listMessage",
        "listMessage": {
            "contentText": "Hello",
            "title": "título",
            "footer": "Hello",
            "buttonText": "Lista de ações",
            "sections": [
                {
                    "title": "Seção 1",
                    "rows": [
                        {
                            "title": "Opção 1",
                            "rowId": "option1"
                        },
                        {
                            "title": "Opção 2",
                            "rowId": "option2",
                            "description": "Explicação"
                        }
                    ]
                },
                {
                    "title": "Seção 2",
                    "rows": [
                        {
                            "title": "Opção 3",
                            "rowId": "option3"
                        },
                        {
                            "title": "Opção 4",
                            "rowId": "option4",
                            "description": "Explicação"
                }
            ],
             "forwardingScore": 4,
             "isForwarded": true
        }
    }
}