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

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

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

typeWebhook = incomingMessageReceived

messageData.typeMessage = pollMessage

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

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

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

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

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

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

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

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

Параметр	Тип	Описание
`name`	string	Название опроса
`options`	array	Массив данных о вариантах выбора опроса
`multipleAnswers`	boolean	Разрешить несколько ответов. `true` — включено, `false` — отключено, По умолчанию: `false`

Поля массива options

Параметр	Тип	Описание
`optionName`	string	Название варианта выбора

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

{
  "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": "Иван",
    "senderName": "Иван",
    "senderContactName": "Иван Васильевич"
  },
  "messageData": {
    "typeMessage": "pollMessage",
    "pollMessageData": {
      "name": "Poll Name",
      "options": [
        {
          "optionName": "Variant 1"
        },
        {
          "optionName": "Variant 2"
        }
      ],
      "multipleAnswers": false
    }
  }
}