telegram.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, **_kwargs)

Bases: telegram.base.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 and pay are equal.

Note

  • You must use exactly one of the optional fields. 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 maybe be an instance of telegram.ext.InvalidCallbackData. This will be the case, if the data associated with the button was already deleted.

    New in version 13.6.

Warning

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

Changed in version 13.6.

Parameters
  • text (str) – Label text on the button.

  • url (str, optional) – HTTP or tg:// url to be opened when button is pressed.

  • login_url (telegram.LoginUrl, optional) – An HTTP URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.

  • callback_data (str | Any, optional) – Data to be sent in a callback query to the bot when button is pressed, UTF-8 1-64 bytes. If the bot instance allows arbitrary callback data, anything can be passed.

  • 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. Can be empty, in which case just the bot’s username will be inserted. This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm* actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.

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

  • callback_game (telegram.CallbackGame, optional) – Description of the game that will be launched when the user presses the button. This type of button must always be the first button in the first row.

  • pay (bool, optional) – Specify True, to send a Pay button. This type of button must always be the first button in the first row.

  • **kwargs (dict) – Arbitrary keyword arguments.

text

Label text on the button.

Type

str

url

Optional. HTTP or tg:// url to be opened when button is pressed.

Type

str

login_url

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

Type

telegram.LoginUrl

callback_data

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

Type

str | object

switch_inline_query

Optional. 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. Can be empty, in which case just the bot’s username will be inserted.

Type

str

switch_inline_query_current_chat

Optional. Will insert the bot’s username and the specified inline query in the current chat’s input field. Can be empty, in which case just the bot’s username will be inserted.

Type

str

callback_game

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

Type

telegram.CallbackGame

pay

Optional. Specify True, to send a Pay button.

Type

bool

update_callback_data(callback_data)

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

New in version 13.6.

Parameters

callback_data (obj) – The new callback data.