Входящее сообщение с опросом#

В данном разделе описывается формат входящего уведомления объекта messageData для входящего сообщения с опросом. Для получения описания общего формата входящих уведомлений обратитесь к разделу Входящие сообщения.

Для получения входящих уведомлений данного вида требуется выполнение двух условий:

typeWebhook = incomingMessageReceived

messageData.typeMessage = pollMessage

Настройка инстанса

Чтобы получать входящие уведомления о сообщениях с опросом, необходимо включить настройку pollMessageWebhook через личный кабинет или методом SetSettings.

Уведомление#

Формат уведомления#

Поля объекта messageData

Параметр	Тип	Описание
`typeMessage`	string	Тип принятого сообщения. Для сообщений данного типа поле принимает значение `pollMessage`
`pollMessageData`	object	Объект данных о принятом опросе
`quotedMessage`	object	Объект данных о цитируемом сообщении. Присутствует только, если само сообщение является цитатой

Поля объекта pollMessageData

Параметр	Тип	Описание
`name`	string	Текст вопроса опроса
`options`	array	Массив вариантов ответа
`allowToChangeAnswer`	boolean	Разрешено ли участникам менять свой ответ (переголосование), принимает значения `true`/`false`

Поля объекта массива options

Параметр	Тип	Описание
`optionName`	string	Текст варианта ответа

Пример тела уведомления#

Пример тела уведомления сообщения с опросом из личного чата#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
      "idInstance": 3100000000,
      "wid": "79991234567@c.us",
      "typeInstance": "v3"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
      "chatId": "10000000",
      "chatName": "Ходабрыш Пробешёлов",
      "chatType": "user",
      "sender": "10000000",
      "senderName": "Ходабрыш Пробешёлов",
      "senderType": "user",
      "senderContactName": "Ходабрыш Пробешёлов",
      "senderPhoneNumber": 79991112233
  },
  "messageData": {
    "typeMessage": "pollMessage",
    "pollMessageData": {
        "name": "Какой мессенджер вы используете чаще всего?",
        "options": [
            {"optionName": "MAX"},
            {"optionName": "Telegram"},
            {"optionName": "WhatsApp"}
        ],
        "allowToChangeAnswer": true
    }
  }
}

Пример тела уведомления сообщения с опросом из группового чата#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
      "idInstance": 3100000000,
      "wid": "79991234567@c.us",
      "typeInstance": "v3"
  },
  "timestamp": 1763115112,
  "idMessage": "1763468266381",
  "senderData": {
      "chatId": "-69876543210123",
      "chatName": "Название группы",
      "chatType": "group",
      "sender": "10000000",
      "senderName": "Ходабрыш",
      "senderType": "user",
      "senderContactName": "",
      "senderPhoneNumber": 0
  },
  "messageData": {
    "typeMessage": "pollMessage",
    "pollMessageData": {
        "name": "Во сколько проведём встречу?",
        "options": [
            {"optionName": "10:00"},
            {"optionName": "14:00"},
            {"optionName": "18:00"}
        ],
        "allowToChangeAnswer": false
    }
  }
}