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

SendInteractiveButtons#

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

Бета-версия

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

Запрос#

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

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

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

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

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

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

Параметр Тип Обязательный Описание
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": "79876543210@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": "79329843267"
        },
        {
            "type": "url",
            "buttonId": "3",
            "buttonText": "Green-api",
            "url": "https://green-api.com"
        }
    ]
}

Ответ#

Поля ответа#

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

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

{
    "idMessage": "3EB0C767D097B7C7C030"
}

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

alt text

Ошибки SendInteractiveButtons#

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

Пример кода#

curl --location --request POST '{{apiUrl}}/waInstance{{idInstance}}/sendInteractiveButtons/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "79876543210@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": "79329843267"
        },
        {
            "type": "url",
            "buttonId": "3",
            "buttonText": "Green-api",
            "url": "https://green-api.com"
        }
    ]
}'