SendTemplateButtons#

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

Запрос#

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

{{apiUrl}}/waInstance{{idInstance}}/sendTemplateButtons/{{apiTokenInstance}}

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

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

• кнопки-ссылки совместимы с кнопками номерами, но не совместимы с кнопками-ответами;
• кнопки с телефонным номером совместимы с кнопками ссылками, но не совместимы с кнопками-ответами;
• кнопки с быстрыми ответами не совместимы с кнопками номерами и кнопками ссылками.

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

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

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

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

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

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

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

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

{
    "chatId": "79876543210@c.us",
    "message": "Hello",
    "footer": "What kind of action will you choose?",
    "templateButtons": [
            {"index": 1, "urlButton": {"displayText": "⭐ Star us on GitHub!", "url": "https://github.com/green-api"}},
            {"index": 2, "callButton": {"displayText": "Call us", "phoneNumber": "+1 (234) 5678-901"}},
            {"index": 3, "quickReplyButton": {"displayText": "Plain button", "id": "plainButtonId"}}
        ]
}

Ответ#

Поля ответа#

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

{
    "idMessage": "3EB0C767D097B7C7C030"
}

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

Кнопка с обратным звонком

Кнопка со ссылкой

Кнопка с быстрым ответом

Ошибки SendTemplateButtons#

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

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

curl --location --request POST '{{apiUrl}}/waInstance{{idInstance}}/sendTemplateButtons/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "79876543210@c.us",
    "message": "Hello",
    "footer": "What kind of action will you choose?",
    "templateButtons": [
            {"index": 1, "urlButton": {"displayText": "⭐ Star us on GitHub!", "url": "https://github.com/green-api"}},
            {"index": 2, "callButton": {"displayText": "Call us", "phoneNumber": "+1 (234) 5678-901"}},
            {"index": 3, "quickReplyButton": {"displayText": "Plain button", "id": "plainButtonId"}}
        ]
}'