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, *, 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
andpay
are equal.Note
Exactly one of the optional fields 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 oftelegram.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.
Warning
Examples
Available In
See also
Changed in version 20.0:
web_app
is considered as well when comparing objects of this type in terms of equality.- Parameters:
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
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.
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.
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.
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.
- 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:
- 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:
- 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.
- 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:
- 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:
- 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:
- 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:
- 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:
- 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.
- 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.
- update_callback_data(callback_data)[source]¶
Sets
callback_data
to the passed object. Intended to be used bytelegram.ext.CallbackDataCache
.Added in version 13.6.
- Parameters:
callback_data (
object
) – The new callback data.