InlineKeyboardButton¶

class telegram.InlineKeyboardButton(text, url=None, callback_data=None, switch_inline_query=None, switch_inline_query_current_chat=None, callback_game=None, pay=None, login_url=None, web_app=None, switch_inline_query_chosen_chat=None, copy_text=None, style=None, icon_custom_emoji_id=None, *, api_kwargs=None)[source]¶

Bases: telegram.TelegramObject

This object represents one button of an inline keyboard.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their text, url, login_url, callback_data, switch_inline_query, switch_inline_query_current_chat, callback_game, web_app, pay, style and icon_custom_emoji_id are equal.

Note

• Exactly one of the fields other than text, icon_custom_emoji_id, and style must be used to specify type of the button.

• Mind that callback_game is not working as expected. Putting a game short name in it might, but is not guaranteed to work.

• If your bot allows for arbitrary callback data, in keyboards returned in a response from telegram, callback_data may be an instance of telegram.ext.InvalidCallbackData. This will be the case, if the data associated with the button was already deleted.

  Added in version 13.6.

• Since Bot API 5.5, it’s now allowed to mention users by their ID in inline keyboards. This will only work in Telegram versions released after December 7, 2021. 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.

Warning

• If your bot allows your arbitrary callback data, buttons whose callback data is a non-hashable object will become unhashable. Trying to evaluate hash(button) will result in a TypeError.

  Changed in version 13.6.

• After Bot API 6.1, only HTTPS links will be allowed in login_url.

Examples

• Inline Keyboard 1

• Inline Keyboard 2

See also

telegram.InlineKeyboardMarkup

Available In

telegram.InlineKeyboardMarkup.inline_keyboard

Changed in version 20.0: web_app 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) – Label text on the button.

• url (str, optional) –

  HTTP or tg:// url to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings.

  Changed in version 13.9: You can now mention a user using tg://user?id=<user_id>.

• login_url (telegram.LoginUrl, optional) –

  An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.

  Caution

  Only HTTPS links are allowed after Bot API 6.1.

• callback_data (str | object, optional) –

  Data to be sent in a callback query to the bot when the button is pressed, UTF-8 1- 64 bytes. If the bot instance allows arbitrary callback data, anything can be passed.

  Tip

  The value entered here will be available in telegram.CallbackQuery.data.

  See also

  Arbitrary callback_data

• web_app (telegram.WebAppInfo, optional) –

  Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answer_web_app_query(). Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.

  Added in version 20.0.

• switch_inline_query (str, optional) –

  If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot’s username and the specified inline query in the input field. May be empty, in which case just the bot’s username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.

  Tip

  This is similar to the parameter switch_inline_query_chosen_chat, but gives no control over which chats can be selected.

• switch_inline_query_current_chat (str, optional) –

  If set, pressing the button will insert the bot’s username and the specified inline query in the current chat’s input field. May be empty, in which case only the bot’s username will be inserted.

  This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.

• copy_text (telegram.CopyTextButton, optional) –

  Description of the button that copies the specified text to the clipboard.

  Added in version 21.7.

• callback_game (telegram.CallbackGame, optional) –

  Description of the game that will be launched when the user presses the button

  Note

  This type of button must always be the first button in the first row.

• pay (bool, optional) –

  Specify True, to send a Pay button. Substrings “⭐️” and “XTR” in the buttons’s text will be replaced with a Telegram Star icon.

  Note

  This type of button must always be the first button in the first row and can only be used in invoice messages.

• 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.

• switch_inline_query_chosen_chat (telegram.SwitchInlineQueryChosenChat, optional) –

  If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot’s username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.

  Added in version 20.3.

  Tip

  This is similar to switch_inline_query, but gives more control on which chats can be selected.

  Caution

  The PTB team has discovered that this field works correctly only if your Telegram client is released after April 20th 2023.

• 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]¶

Label text on the button.

Type:

str

url[source]¶

Optional. HTTP or tg:// url to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings.

Changed in version 13.9: You can now mention a user using tg://user?id=<user_id>.

Type:

str

login_url[source]¶

Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.

Caution

Only HTTPS links are allowed after Bot API 6.1.

Type:

telegram.LoginUrl

callback_data[source]¶

Optional. Data to be sent in a callback query to the bot when the button is pressed, UTF-8 1- 64 bytes.

Type:

str | object

web_app[source]¶

Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answer_web_app_query(). Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.

Added in version 20.0.

Type:

telegram.WebAppInfo

switch_inline_query[source]¶

Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot’s username and the specified inline query in the input field. May be empty, in which case just the bot’s username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.

Tip

This is similar to the parameter switch_inline_query_chosen_chat, but gives no control over which chats can be selected.

Type:

str

switch_inline_query_current_chat[source]¶

Optional. If set, pressing the button will insert the bot’s username and the specified inline query in the current chat’s input field. May be empty, in which case only the bot’s username will be inserted.

This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.

Type:

str

copy_text[source]¶

Optional. Description of the button that copies the specified text to the clipboard.

Added in version 21.7.

Type:

telegram.CopyTextButton

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

callback_game[source]¶

Optional. Description of the game that will be launched when the user presses the button.

Note

This type of button must always be the first button in the first row.

Type:

telegram.CallbackGame

pay[source]¶

Optional. Specify True, to send a Pay button. Substrings “⭐️” and “XTR” in the buttons’s text will be replaced with a Telegram Star icon.

Note

This type of button must always be the first button in the first row and can only be used in invoice messages.

Type:

bool

switch_inline_query_chosen_chat[source]¶

Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot’s username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.

Added in version 20.3.

Tip

This is similar to switch_inline_query, but gives more control on which chats can be selected.

Caution

The PTB team has discovered that this field works correctly only if your Telegram client is released after April 20th 2023.

Type:

telegram.SwitchInlineQueryChosenChat

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

MAX_CALLBACK_DATA = 64[source]¶

telegram.constants.InlineKeyboardButtonLimit.MAX_CALLBACK_DATA

Added in version 20.0.

MIN_CALLBACK_DATA = 1[source]¶

telegram.constants.InlineKeyboardButtonLimit.MIN_CALLBACK_DATA

Added in version 20.0.

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

See telegram.TelegramObject.de_json().

update_callback_data(callback_data)[source]¶

Sets callback_data to the passed object. Intended to be used by telegram.ext.CallbackDataCache.

Added in version 13.6.

Parameters:

callback_data (object) – The new callback data.