GramIO API Reference / gramio/dist / TelegramKeyboardButton
Interface: TelegramKeyboardButton
Defined in: @gramio/types/out/objects.d.ts:3045
This object represents one button of the reply keyboard. At most one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button. For simple text buttons, String can be used instead of this object to specify the button text.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
icon_custom_emoji_id? | string | 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. | @gramio/types/out/objects.d.ts:3053 |
request_chat? | TelegramKeyboardButtonRequestChat | 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. | @gramio/types/out/objects.d.ts:3065 |
request_contact? | boolean | Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only. | @gramio/types/out/objects.d.ts:3069 |
request_location? | boolean | Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only. | @gramio/types/out/objects.d.ts:3073 |
request_poll? | TelegramKeyboardButtonPollType | 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. | @gramio/types/out/objects.d.ts:3077 |
request_users? | TelegramKeyboardButtonRequestUsers | 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. | @gramio/types/out/objects.d.ts:3061 |
style? | TelegramKeyboardButtonStyle | Optional. Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used. | @gramio/types/out/objects.d.ts:3057 |
text | string | Text of the button. If none of the fields other than text, icon_custom_emoji_id, and style are used, it will be sent as a message when the button is pressed | @gramio/types/out/objects.d.ts:3049 |
web_app? | TelegramWebAppInfo | 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. | @gramio/types/out/objects.d.ts:3081 |