KeyboardButton¶
- class telegram.KeyboardButton(text, request_contact=None, request_location=None, request_poll=None, web_app=None, request_chat=None, request_users=None, *, api_kwargs=None)[source]¶
Bases:
telegram.TelegramObject
This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons,
str
can be used instead of this object to specify text of the button.Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their
text
,request_contact
,request_location
,request_poll
,web_app
,request_users
andrequest_chat
are equal.Note
Optional fields are mutually exclusive.
request_contact
andrequest_location
options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.request_poll
option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.web_app
option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message.request_users
andrequest_chat
options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.
Available In
Changed in version 21.0: Removed deprecated argument and attribute
request_user
.Changed in version 20.0:
web_app
is considered as well when comparing objects of this type in terms of equality.Changed in version 20.5:
request_users
andrequest_chat
are considered as well when comparing objects of this type in terms of equality.- Parameters:
text (
str
) – Text of the button. If none of the optional fields are used, it will be sent to the bot as a message when the button is pressed.request_contact (
bool
, optional) – IfTrue
, 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) – IfTrue
, 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
Message.web_app_data
service message. Available in private chats only.Added in version 20.0.
request_users (
KeyboardButtonRequestUsers
, optional) –If specified, pressing the button will open a list of suitable users. Tapping on any user will send its identifier to the bot in a
telegram.Message.users_shared
service message. Available in private chats only.Added in version 20.8.
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
telegram.Message.chat_shared
service message. Available in private chats only.Added in version 20.1.
- text[source]¶
Text of the button. If none of the optional fields are used, it will be sent to the bot as a message when the button is pressed.
- Type:
- request_contact[source]¶
Optional. If
True
, the user’s phone number will be sent as a contact when the button is pressed. Available in private chats only.- Type:
- request_location[source]¶
Optional. If
True
, the user’s current location will be sent when the button is pressed. Available in private chats only.- Type:
- request_poll[source]¶
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.
- Type:
- web_app[source]¶
Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a
Message.web_app_data
service message. Available in private chats only.Added in version 20.0.
- Type:
- request_users[source]¶
Optional. If specified, pressing the button will open a list of suitable users. Tapping on any user will send its identifier to the bot in a
telegram.Message.users_shared
service message. Available in private chats only.Added in version 20.8.
- request_chat[source]¶
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
telegram.Message.chat_shared
service message. Available in private chats only.Added in version 20.1.