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

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

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

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

typeWebhook = outgoingMessageReceived

messageData.typeMessage = pollMessage

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

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

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

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

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

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

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

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

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

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

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

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

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

{
  "typeWebhook": "outgoingMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "tgm"
  },
  "timestamp": 1588091580,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "1000000000",
    "sender": "1000000001",
      "chatName": "Иван",
    "senderName": "Иван",
    "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "pollMessage",
    "pollMessageData": {
      "name": "Poll Name",
      "options": [
        {"optionName": "Variant 1"},
        {"optionName": "Variant 2"}
      ],
      "multipleAnswers": false
    }
  }
}

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

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