Mensagem de entrada da pesquisa#
Esta seção descreve o formato da notificação de entrada do objeto messageData para a mensagem de entrada da pesquisa. Para obter a 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, são necessárias duas condições:
typeWebhook = incomingMessageReceived
messageData.typeMessage = pollMessage
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 pollMessage |
pollCreationMessage | object | Objeto de dados sobre a mensagem da pesquisa |
Campos do objeto pollCreationMessage
| Parâmetro | Tipo | Descrição |
|---|---|---|
name | string | Nome da pesquisa |
options | object | Objeto de dados sobre as opções de escolha da pesquisa |
selectableOptionsCount | number | Número de opções selecionáveis |
Campos do objeto options
| Parâmetro | Tipo | Descrição |
|---|---|---|
optionName | string | Nome da opção de escolha |
Exemplo do corpo da notificação#
```json { "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": "pollMessage", "pollCreationMessage": { "name": "Poll Name", "options": [ { "optionName": "Variant 1" }, { "optionName": "Variant 2" } ], "selectableOptionsCount": 0 } } } ``````