Тип данных KeyboardButton

Этот объект представляет одну кнопку клавиатуры ответа в Telegram Bot API с различными типами действий при нажатии.

Описание

Этот объект представляет одну кнопку клавиатуры ответа. Не более одного из необязательных полей может быть использовано для указания типа кнопки. Для простых текстовых кнопок вместо этого объекта можно использовать String, чтобы указать текст кнопки.

Поле Тип Описание
text String Текст кнопки. Если ни одно из необязательных полей не используется, этот текст будет отправлен как сообщение при нажатии кнопки
request_users KeyboardButtonRequestUsers Необязательное. Если указано, нажатие на кнопку откроет список подходящих пользователей. Идентификаторы выбранных пользователей будут отправлены боту в служебном сообщении "users_shared". Доступно только в личных чатах.
request_chat KeyboardButtonRequestChat Необязательное. Если указано, нажатие на кнопку откроет список подходящих чатов. Нажатие на чат отправит его идентификатор боту в служебном сообщении "chat_shared". Доступно только в личных чатах.
request_contact Boolean Необязательное. Если True, номер телефона пользователя будет отправлен как контакт при нажатии кнопки. Доступно только в личных чатах.
request_location Boolean Необязательное. Если True, текущее местоположение пользователя будет отправлено при нажатии кнопки. Доступно только в личных чатах.
request_poll KeyboardButtonPollType Необязательное. Если указано, пользователю будет предложено создать опрос и отправить его боту при нажатии кнопки. Доступно только в личных чатах.
web_app WebAppInfo Необязательное. Если указано, описанное Веб-приложение будет запущено при нажатии кнопки. Веб-приложение сможет отправить служебное сообщение "web_app_data". Доступно только в личных чатах.

Примечание: опции request_users и request_chat будут работать только в версиях Telegram, выпущенных после 3 февраля 2023 года. Более старые клиенты покажут неподдерживаемое сообщение.

Примеры

json

{
  "text": "Share Contact",
  "request_contact": true
}

История изменений

  • API 2.0. Добавлен объект KeyboardButton
  • API 4.6. Обновлен объект KeyboardButton: Добавлено поле request_poll
  • API 6.0. Обновлен объект KeyboardButton: Добавлено поле web_app
  • API 6.5. Обновлен объект KeyboardButton: Добавлено поле request_user
  • API 7.0. Обновлен объект KeyboardButton: Переименовано поле request_user в request_users

Дополнительно

  • KeyboardButtonRequestUsers - Объект, определяющий критерии для запроса подходящих пользователей через кнопку клавиатуры бота.
  • KeyboardButtonRequestChat - Объект, определяющий критерии для запроса подходящего чата через кнопку клавиатуры, с настройкой типа чата, прав администраторов и запрашиваемой информации.
  • KeyboardButtonPollType - Объект определяет тип опроса, который можно создать при нажатии кнопки в интерфейсе бота.
  • WebAppInfo - Объект, содержащий информацию о Веб-приложении для его открытия с дополнительными данными.
Комментарии