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

SendInteractiveButtons#

Postman Apidog

Метод предназначен для отправки сообщения с кнопками в личные чаты. Метод отправляет кнопки для передачи информации, ссылок и номера телефона для звонка.

Бета-версия

Функциональность находится в режиме бета-версии. Функции могут быть изменены, а также могут работать нестабильно.

Запрос#

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

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

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

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

  • в названии кнопки может быть не более 25 символов.
  • может быть не более 3 кнопок в одном сообщении.

Перечень поддерживаемых операционных систем и платформ#

Все поддерживаемые платформы указаны для актуальных версий WhatsApp.

ОС или платформа Поддержка метода
Whatsapp WEB Есть
Windows Desktop Не поддерживается
Android Есть
iOS Есть
iPadOS Есть

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

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

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

Параметр Тип Обязательный Описание
type string Да Тип отправляемого сообщения. Всего существует 3 типа: copy, call и url. COPY- позволяет быстро скопировать содержимое кнопки. CALL - позволяет нажатием кнопки начать звонок. URL - позволяет по нажатию кнопки открыть ссылку.
buttonId string Да Идентификатор кнопки
buttonText string Да Текст на кнопке
copyCode string Нет Поле для кнопки с типом COPY, является значением для копирования при нажатии на кнопку
phoneNumber string Нет Поле для кнопки с типом CALL, номер телефона на который будет осуществляться звонок при нажатии на кнопку
url string Нет Поле для кнопки с типом URL, ссылка на которую будет осуществляться переход при нажатии на кнопку

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

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

{
    "chatId": "79871234567@c.us",
    "header": "Header",
    "body": "Body",
    "footer": "Footer",
    "buttons": [
        {
            "type": "copy",
            "buttonId": "1",
            "buttonText": "Copy me",
            "copyCode": "3333"
        },
        {
            "type": "call",
            "buttonId": "2",
            "buttonText": "Call me",
            "phoneNumber": "79879876543"
        },
        {
            "type": "url",
            "buttonId": "3",
            "buttonText": "Green-api",
            "url": "https://green-api.com"
        }
    ]
}

Отправка сообщений с кнопками разного типа#

Внимание. Для совместной отправки сообщения с кнопками разного типа следуйте указаниям.

Для отправки сообщений такого типа действует больше ограничений.

Перечень поддерживаемых операционных систем и платформ#

Для отправки кнопок смешанного типа поддерживаются следующие системы и платформы

Все поддерживаемые платформы указаны для актуальных версий WhatsApp.

ОС или платформа Поддержка метода
Whatsapp WEB Не поддерживается
Windows Desktop Не поддерживается
Android Есть
iOS Есть
iPadOS Есть

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

Для отправки кнопок смешанного типа имеются следнющие ограничения:
- в названии кнопки может быть не более 25 символов.
- может быть не более 3 кнопок в одном сообщении.
- кнопку можно нажать только 1 раз.
- для создания кнопки с ответами используйте правила метода SendInteractiveButtonsReply.

Отправка сообщения в личный чат смешенных кнопок#

{
    "chatId": "79871234567@c.us",
    "header": "Different button options",
    "body": "Different levels of headings",
    "footer": "But still in testing",
    "buttons": [
        {
            "type": "url",
            "buttonId": "1",
            "buttonText": "Green-api",
            "url": "http://green-api.com"
        },
        {
            "type": "reply",
            "buttonId": "2",
            "buttonText": "Reply button"
        }
    ]
}

Ответ#

Поля ответа#

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

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

{
    "idMessage": "3EB0C767D097B7C7C030"
}

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

alt text

Ошибки SendInteractiveButtons#

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

Пример кода#

curl --location --request POST '{{apiUrl}}/waInstance{{idInstance}}/sendInteractiveButtons/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "79871234567@c.us",
    "header": "Header",
    "body": "Body",
    "footer": "Footer",
    "buttons": [
        {
            "type": "copy",
            "buttonId": "1",
            "buttonText": "Copy me",
            "copyCode": "3333"
        },
        {
            "type": "call",
            "buttonId": "2",
            "buttonText": "Call me",
            "phoneNumber": "79879876543"
        },
        {
            "type": "url",
            "buttonId": "3",
            "buttonText": "Green-api",
            "url": "https://green-api.com"
        }
    ]
}'