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

Отправленное сообщение с обновлением опроса#

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

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

typeWebhook = outgoingMessageReceived || outgoingAPIMessageReceived

messageData.typeMessage = pollUpdateMessage

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

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

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

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

    • Если выбрать вариант в опросе, затем сразу его отменить, то вебхук pollUpdateMessage придет по последнему состоянию опроса.
    • Если выбрать вариант в опросе, затем его отменить спустя секунду или позже, то вебхук pollUpdateMessage придет по обоим состояниям опроса.

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

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

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

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

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

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

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

Параметр Тип Описание
optionName string Название варианта выбора
optionVoters array Массив wid пользователей выбравшие этот вариант

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

Параметр Тип Описание
default string Wid пользователя, выбравшего опцию

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

{
  "typeWebhook": "outgoingMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "BAE59C345928CB13",
  "senderData": {
    "chatId": "79001234567@c.us",
    "sender": "79876543210@c.us",
      "chatName": "Василиса",
    "senderName": "Иван",
    "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "pollUpdateMessage",
    "pollMessageData": {
      "stanzaId": "BAE53AFDD5F0C000",
      "name": "Poll Name",
      "votes": [
        {
          "optionName": "Variant 1",
          "optionVoters": []
        },
        {
          "optionName": "Variant 2",
          "optionVoters": ["79876543210@c.us"]
        }
      ],
      "multipleAnswers": false
    }
  }
}

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

{
    "typeWebhook": "outgoingAPIMessageReceived",
    "instanceData": {
        "idInstance": 1101111111,
        "wid": "79876543210@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1732268220,
    "idMessage": "BAE59C345928CB13",
    "senderData": {
      "chatId": "120363369140947676@g.us",
        "chatName": "Группа",
        "sender": "79876543210@c.us",
        "senderName": "Иван",
        "senderContactName": "Иван Царевич"
  },
  "messageData": {
    "typeMessage": "pollUpdateMessage",
    "pollMessageData": {
      "stanzaId": "BAE53AFDD5F0C000",
      "name": "Poll Name",
      "votes": [
        {
          "optionName": "Variant 1",
          "optionVoters": []
        },
        {
          "optionName": "Variant 2",
          "optionVoters": ["79876543210@c.us"]
        }
      ],
      "multipleAnswers": false
    }
  }
}