Входящее сообщение со списком выбора#

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

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

typeWebhook = incomingMessageReceived

messageData.typeMessage = listMessage

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

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

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

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

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

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

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

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

Параметр	Тип	Описание
`contentText`	string	Текстовое сообщение тела кнопок
`title`	string	Нет
`footer`	string	Текстовое сообщение подвала кнопок
`buttonText`	string	Нет
`sections`	array	Да
`isForwarded`	boolean	Является ли сообщение пересланным, принимает значения `true`/`false`
`forwardingScore`	integer	Количество пересылок сообщения

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

Параметр	Тип	Описание
`title`	string	заголовок списка выбора
`rows`	array	значения списка выбора

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

Параметр	Тип	Описание
`title`	string	текст значения списка
`rowId`	string	идентификатор значения списка
`description`	string	описание значения списка

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

Параметр	Тип	Описание
`stanzaId`	string	id цитируемого сообщения
`participant`	string	id отправителя цитируемого сообщения
`typeMessage`	string	Тип цитируемого сообщения

Остальные поля заполняются в зависимости от типа цитируемого сообщения и идентичны полям входящих сообщений описанных в разделе Входящие сообщения

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1101111111,
    "wid": "79876543210@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234567@c.us",
    "sender": "79001234567@c.us",
    "chatName": "Иван",
    "senderName": "Иван",
    "senderContactName": "Иван Царевич"
  },
    "messageData": {
        "typeMessage": "listMessage",
        "listMessage": {
            "contentText": "Hello",
            "title": "заголовок",
            "footer": "Hello",
            "buttonText": "Список действий",
            "sections": [
                {
                    "title": "Секция 1",
                    "rows": [
                        {
                            "title": "Вариант 1",
                            "rowId": "option1"
                        },
                        {
                            "title": "Вариант 2",
                            "rowId": "option2",
                            "description": "Пояснение"
                        }
                    ]
                },
                {
                    "title": "Секция 2",
                    "rows": [
                        {
                            "title": "Опция 3",
                            "rowId": "option3"
                        },
                        {
                            "title": "Опция 4",
                            "rowId": "option4",
                            "description": "Пояснение"
                }
            ],
             "forwardingScore": 4,
             "isForwarded": true
        }
    }
}