[go: up one dir, main page]

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

SendButtons#

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

При вызове метода вернется ошибка 403.

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

Запрос#

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

POST
{{apiUrl}}/waInstance{{idInstance}}/sendButtons/{{apiTokenInstance}}

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

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

  • в названии кнопки может быть не более 25 символов;
  • может быть не более 3 кнопок такого вида;
  • кнопку можно нажать только 1 раз.

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

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

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

Параметр Тип Описание
buttonId string Идентификатор кнопки
buttonText string текст на кнопке

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

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

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

{
    "chatId": "11001234567@c.us",
    "message": "Hello",
    "footer": "Please choose the color:",
    "buttons": [
        {
            "buttonId": "1",
            "buttonText": "green"
        },
        {
            "buttonId": "2",
            "buttonText": "red"
        },
        {
            "buttonId": "3",
            "buttonText": "blue"
        }
    ]
}

Ответ#

Поля ответа#

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

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

{
    "idMessage": "3EB0C767D097B7C7C030"
}

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

Пример отображения кнопок

Ошибки SendButtons#

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

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

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

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

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

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

1 - действие 1

2 - действие 2

3 - действие 3

Пример curl#

curl --location --request POST '{{apiUrl}}/waInstance{{idInstance}}/sendButtons/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "11001234567@c.us",
    "message": "Please choose the color:",
    "buttons": [{"buttonId": "1", "buttonText": "green"}, {"buttonId": "2", "buttonText": "red"}, {"buttonId": "3", "buttonText": "blue"}]
}'