SendListMessage#

Внимание! Метод временно не работает

Метод предназначен для отправки сообщения с кнопкой выбора из списка значений в личный или групповой чат. Сообщение будет добавлено в очередь на отправку. Сообщение на отправку хранится 24 часа в очереди и будет отправлено сразу же после авторизации телефона. Скорость отправки сообщений из очереди регулирует параметр Интервал отправки сообщений.

Запрос#

Для отправки требуется выполнить запрос по адресу:

POST

{{apiUrl}}/waInstance{{idInstance}}/sendListMessage/{{apiTokenInstance}}

Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

Особенности при работе с кнопками#

число кнопок может быть от 3 до 10 включительно;
длина названия кнопки до 24 символов;
названия пунктов меню могут повторяться.

Параметры запроса#

Параметр	Тип	Обязательный	Описание
`chatId`	string	Да	Идентификатор чата
`message`	string	Да	Текст сообщения. Поддерживаются символы emoji 😃
`title`	string	Нет	Заголовок сообщения.
`footer`	string	Нет	Подвал сообщения. Удобен для визуального выделения текста, который относится к кнопкам
`buttonText`	string	Да	надпись на кнопке списка выбора
`sections`	array	Да	значения списка выбора
`quotedMessageId`	string	Нет	Идентификатор цитируемого сообщения,если указан то сообщение отправится с цитированием указанного сообщения чата

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

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

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

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

Максимальная длина текстового сообщения составляет 4096 символов

Пример тела запроса#

Отправка сообщения в личный чат:

{
    "chatId": "79876543210@c.us",
    "message": "Текст сообщения",
    "title": "заголовок",
    "footer": "подвал",
    "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": "Пояснение"
                }
            ]
        }
    ]
}

Ответ#

Поля ответа#

Поле	Тип	Описание
`idMessage`	string	Идентификатор отправленного сообщения

Пример тела ответа#

{
    "idMessage": "3EB0C767D097B7C7C030"
}

Пример отображения у получателя#

Пример списка выбора

Ошибки SendListMessage#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Возможные ошибки

При использовании метода SendListMessage сообщения могут не отображаться в веб, десктоп и мобильной версиях приложения. Возможность отправки сообщений с кнопками реализована нами низкоуровневым способом. Официальный клиент WhatsApp-Web не предоставляет функции отправки кнопок. В большей степени, стабильность работы метода SendListMessage не зависит от нас, WhatsApp постоянно вносит изменения в их работу.

Рекомендуем всегда дублировать кнопки обычными сообщениями.

Например использовать цифры для определения выбора.

Выберете действие:

1 - действие 1

2 - действие 2

3 - действие 3

Пример кода на cURL#

cURL

curl --location --request POST '{{apiUrl}}/waInstance{{idInstance}}/sendListMessage/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "11001234567@c.us",
    "message": "Текст сообщения",
    "buttonText": "Список действий",
    "title": "заголовок",
    "footer": "подвал",
    "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": "Пояснение"
                }
            ]
        }
    ]
}'