InlineKeyboardButton#

class pyrogram.types.InlineKeyboardButton#

One button of an inline keyboard.

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

Parameters:

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

  • icon_custom_emoji_id (int, 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..

  • style (ButtonStyle, optional) – Style of the button. If omitted, then an app-specific style is used.

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

  • user_id (int, optional) – User id, for links to the user profile.

  • callback_data (str | bytes, optional) – Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes.

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

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

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

  • switch_inline_query_chosen_chat (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

  • copy_text (CopyTextButton, optional) – Description of the button that copies the specified text to the clipboard.

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

  • callback_data_with_password (bytes, optional) – A button that asks for the 2-step verification password of the current user and then sends a callback query to a bot Data to be sent to the bot via a callback query.