Poll message
POST/Documentation Poll message sent via API
To receive this type of notification, you must enable the settings in your personal account or using the SetSettings method:
"outgoingAPIMessageWebhook": "yes"
"pollMessageWebhook": "yes"
Request
Body Params application/json
typeWebhook
string
required
instanceData
object
required
idInstance
integer
required
wid
string
required
typeInstance
string
required
timestamp
integer
required
idMessage
string
required
senderData
object
required
chatId
string
required
chatName
string
required
sender
string
required
senderName
string
required
senderContactName
string
required
messageData
object
required
typeMessage
string
required
pollMessageData
object
required
Example
{
"typeWebhook": "outgoingAPIMessageReceived",
"instanceData": {
"idInstance": 1101000002,
"wid": "71234567890@c.us",
"typeInstance": "whatsapp"
},
"timestamp": 1705523078,
"idMessage": "30F6A068486C79D01CC683822E9258AE",
"senderData": {
"chatId": "71231234567@c.us",
"chatName": "Green API user",
"sender": "71234567890@c.us",
"senderName": "Green API",
"senderContactName": "Green API inContacts"
},
"messageData": {
"typeMessage": "pollMessage",
"pollMessageData": {
"name": "Color",
"options": [
{
"optionName": "Red"
},
{
"optionName": "Black"
}
],
"multipleAnswers": true
}
}
}Request samples
Responses
Poll message in the journal(200)
Poll message in the journal
HTTP Code: 200
Content Type : Rawtext/plain
Example
Not configured
Last modified: 19 days ago