Poll message

POST

https://api.green-api.com/

Documentation Poll message sent from phone

To receive this type of notification, you must enable the settings in your personal account or using the SetSettings method:
"outgoingMessageWebhook": "yes",
"pollMessageWebhook": "yes"

Request

Body Params application/json

Example

{
    "typeWebhook": "outgoingMessageReceived",
    "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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.green-api.com/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "typeWebhook": "outgoingMessageReceived",
    "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
        }
    }
}'

Responses

🟢200Poll message in the journal

text/plain

Body

Modified at 2025-07-08 14:43:36

Sticker message

Reaction message