Описание
Этот объект представляет одну кнопку встроенной клавиатуры. Ровно одно из необязательных полей должно быть использовано для указания типа кнопки.
| Поле | Тип | Описание |
|---|---|---|
| text | String | Текст метки на кнопке |
| url | String | Необязательное. HTTP или tg:// URL, который откроется при нажатии кнопки. Ссылки tg://user?id=<user_id> можно использовать для упоминания пользователя по его идентификатору без использования имени пользователя, если это разрешено его настройками конфиденциальности. |
| callback_data | String | Необязательное. Данные, которые будут отправлены в CallbackQuery боту при нажатии кнопки, 1-64 байта |
| web_app | WebAppInfo | Необязательное. Описание Веб-приложения, которое будет запущено при нажатии пользователем кнопки. Веб-приложение сможет отправить произвольное сообщение от имени пользователя с помощью метода answerWebAppQuery. Доступно только в личных чатах между пользователем и ботом. Не поддерживается для сообщений, отправленных от имени бизнес-аккаунта Telegram. |
| login_url | LoginUrl | Необязательное. HTTPS URL, используемый для автоматической авторизации пользователя. Может использоваться в качестве замены Виджета входа Telegram. |
| switch_inline_query | String | Необязательное. Если установлено, нажатие кнопки предложит пользователю выбрать один из своих чатов, открыть этот чат и вставить имя пользователя бота и указанный инлайн-запрос в поле ввода. Может быть пустым, в этом случае будет вставлено только имя пользователя бота. Не поддерживается для сообщений, отправленных в личных сообщениях каналов и от имени бизнес-аккаунта Telegram. |
| switch_inline_query_current_chat | String | Необязательное. Если установлено, нажатие кнопки вставит имя пользователя бота и указанный инлайн-запрос в поле ввода текущего чата. Может быть пустым, в этом случае будет вставлено только имя пользователя бота. Это предлагает пользователю быстрый способ открыть вашего бота в инлайн-режиме в том же чате — удобно для выбора чего-либо из нескольких вариантов. Не поддерживается в каналах, для сообщений в личных сообщениях каналов и от имени бизнес-аккаунта Telegram. |
| switch_inline_query_chosen_chat | SwitchInlineQueryChosenChat | Необязательное. Если установлено, нажатие кнопки предложит пользователю выбрать один из своих чатов указанного типа, открыть этот чат и вставить имя пользователя бота и указанный инлайн-запрос в поле ввода. Не поддерживается для сообщений, отправленных в личных сообщениях каналов и от имени бизнес-аккаунта Telegram. |
| copy_text | CopyTextButton | Необязательное. Описание кнопки, которая копирует указанный текст в буфер обмена. |
| callback_game | CallbackGame | Необязательное. Описание игры, которая будет запущена при нажатии пользователем кнопки. ПРИМЕЧАНИЕ: Этот тип кнопки всегда должен быть первой кнопкой в первом ряду. |
| pay | Boolean | Необязательное. Укажите True, чтобы отправить кнопку оплаты. Подстроки « » и «XTR» в тексте кнопки будут заменены на иконку Telegram Star.ПРИМЕЧАНИЕ: Этот тип кнопки всегда должен быть первой кнопкой в первом ряду и может использоваться только в сообщениях со счётом. |
Примеры
json
{
"text": "Click me",
"callback_data": "button_clicked"
}История изменений
- API 2.0. Добавлен объект InlineKeyboardButton
- API 2.2.. Обновлен объект InlineKeyboardButton: Добавлено поле callback_game
- API 3.0. Обновлен объект InlineKeyboardButton: Добавлен новый тип кнопки pay
- API 4.3. Обновлен объект InlineKeyboardButton: Добавлено поле login_url для автоматической авторизации пользователей
- API 6.0. Обновлен объект InlineKeyboardButton: Добавлено поле web_app
- API 6.7. Обновлен объект InlineKeyboardButton: Добавлено поле switch_inline_query_chosen_chat типа SwitchInlineQueryChosenChat
- API 7.11. Обновлен объект InlineKeyboardButton: Добавлено поле copy_text
Дополнительно
- CallbackQuery - Объект представляет входящий запрос от нажатия кнопки обратного вызова в инлайн-клавиатуре и содержит информацию о запросе, отправителе и связанных данных.
- WebAppInfo - Объект, содержащий информацию о Веб-приложении для его открытия с дополнительными данными.
- answerWebAppQuery - Метод устанавливает результат взаимодействия с веб-приложением и отправляет соответствующее сообщение от имени пользователя в исходный чат.
- LoginUrl - Объект LoginUrl представляет параметр кнопки встроенной клавиатуры для автоматической авторизации пользователя на внешнем сайте через Telegram.
- SwitchInlineQueryChosenChat - Объект для инлайн-кнопки, переключающей пользователя в режим инлайн-поиска в выбранном чате с настраиваемыми параметрами доступных чатов.
- CopyTextButton - Кнопка встроенной клавиатуры для копирования заданного текста в буфер обмена.
- CallbackGame - Пустой объект-заглушка для игр, который настраивается через BotFather.