Перейти к содержанию

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

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

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

  • typeWebhook = incomingMessageReceived
  • messageData.typeMessage = pollMessage

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

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

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

  2. Через метод SetSettings включить настройки incomingWebhook иpollMessageWebhook

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

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

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

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

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

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

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

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

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1732268220,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "-10000000000000",
    "chatType": "channel",
    "chatName": "Тридесятое Царство",
    "sender": "1000000000",
    "senderName": "Иван",
    "senderType": "user",
    "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "pollMessage",
    "pollMessageData": {
      "name": "Poll Name",
      "options": [{ "optionName": "Variant 1" }, { "optionName": "Variant 2" }],
      "multipleAnswers": false,
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}