KeyboardButton

class telegram.KeyboardButton(text, request_contact=None, request_location=None, request_poll=None, web_app=None, request_chat=None, request_users=None, style=None, icon_custom_emoji_id=None, *, api_kwargs=None)[source]

Bases: telegram.TelegramObject

This object represents one button of the reply keyboard. At most one of the optional fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button. For simple text buttons, str can be used instead of this object to specify text of the button.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their text, request_contact, request_location, request_poll, web_app, request_users, request_chat, style and icon_custom_emoji_id are equal.

Note

  • Optional fields are mutually exclusive.

  • request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.

  • request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.

  • web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message.

  • request_users and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.

  • style option will only work in Telegram versions released after February 9, 2026. Older clients will display buttons without styling.

Available In

telegram.ReplyKeyboardMarkup.keyboard

Changed in version 21.0: Removed deprecated argument and attribute request_user.

Changed in version 20.0: web_app is considered as well when comparing objects of this type in terms of equality.

Changed in version 20.5: request_users and request_chat are considered as well when comparing objects of this type in terms of equality.

Changed in version 22.7: icon_custom_emoji_id is considered as well when comparing objects of this type in terms of equality.

Changed in version 22.7: style and icon_custom_emoji_id are considered as well when comparing objects of this type in terms of equality.

Parameters:

  • text (str) – Text of the button. If none of the fields other than text, icon_custom_emoji_id, and style are used, it will be sent as a message when the button is pressed.

  • request_contact (bool, optional) – If True, the user’s phone number will be sent as a contact when the button is pressed. Available in private chats only.

  • request_location (bool, optional) – If True, the user’s current location will be sent when the button is pressed. Available in private chats only.

  • request_poll (KeyboardButtonPollType, optional) – If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.

  • web_app (WebAppInfo, optional) –

    If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a Message.web_app_data service message. Available in private chats only.

    Added in version 20.0.

  • request_users (KeyboardButtonRequestUsers, optional) –

    If specified, pressing the button will open a list of suitable users. Tapping on any user will send its identifier to the bot in a telegram.Message.users_shared service message. Available in private chats only.

    Added in version 20.8.

  • request_chat (KeyboardButtonRequestChat, optional) –

    If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a telegram.Message.chat_shared service message. Available in private chats only.

    Added in version 20.1.

  • style (str, optional) –

    Style of the button. Must be one of 'primary' (blue), 'success' (green), and 'danger' (red). Color name aliases 'primary', 'success', and 'danger' are also available. If omitted, then an app-specific style is used.

    Added in version 22.7.

  • icon_custom_emoji_id (str, optional) –

    Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.

    Added in version 22.7.

text[source]

Text of the button. If none of the fields other than text, icon_custom_emoji_id, and style are used, it will be sent as a message when the button is pressed.

Type:

str

request_contact[source]

Optional. If True, the user’s phone number will be sent as a contact when the button is pressed. Available in private chats only.

Type:

bool

request_location[source]

Optional. If True, the user’s current location will be sent when the button is pressed. Available in private chats only.

Type:

bool

request_poll[source]

Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.

Type:

KeyboardButtonPollType

web_app[source]

Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a Message.web_app_data service message. Available in private chats only.

Added in version 20.0.

Type:

WebAppInfo

request_users[source]

Optional. If specified, pressing the button will open a list of suitable users. Tapping on any user will send its identifier to the bot in a telegram.Message.users_shared service message. Available in private chats only.

Added in version 20.8.

Type:

KeyboardButtonRequestUsers

request_chat[source]

Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a telegram.Message.chat_shared service message. Available in private chats only.

Added in version 20.1.

Type:

KeyboardButtonRequestChat

style[source]

Optional. Style of the button. Must be one of 'primary' (blue), 'success' (green), and 'danger' (red). Color name aliases 'primary', 'success', and 'danger' are also available. If omitted, then an app-specific style is used.

Added in version 22.7.

Type:

str

icon_custom_emoji_id[source]

Optional. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.

Added in version 22.7.

Type:

str

classmethod de_json(data, bot=None)[source]

See telegram.TelegramObject.de_json().