KeyboardButton#

class pyrogram.types.KeyboardButton#

One button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields are mutually exclusive.

Parameters:

  • text (str) – Text of the button. If none of the optional fields 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 “web_app_data” service message. Available in private chats only.

  • request_users (KeyboardButtonRequestUsers, optional) – If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a “users_shared” service message. Available in private chats only.

  • 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 “chat_shared” service message. Available in private chats only.