telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Interface KeyboardButton

    Represents one button of the reply keyboard.

    Telegram Bot API: KeyboardButton

    interface KeyboardButton {
        icon_custom_emoji_id?: string;
        request_chat?: KeyboardButtonRequestChat;
        request_contact?: boolean;
        request_location?: boolean;
        request_managed_bot?: KeyboardButtonRequestManagedBot;
        request_poll?: KeyboardButtonPollType;
        request_users?: KeyboardButtonRequestUsers;
        style?: string;
        text: string;
        web_app?: WebAppInfo;
    }
    Index
    icon_custom_emoji_id? request_chat? request_contact? request_location? request_managed_bot? request_poll? request_users? style? text web_app?
    icon_custom_emoji_id?: string

    Unique identifier of the custom emoji shown before the text of the button.

    request_chat?: KeyboardButtonRequestChat

    If specified, pressing the button will open a list of suitable chats.

    request_contact?: boolean

    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?: boolean

    If True, the user's current location will be sent when the button is pressed. Available in private chats only.

    request_managed_bot?: KeyboardButtonRequestManagedBot

    If specified, pressing the button will ask the user to create and share a bot that will be managed by the current bot. Available in private chats only.

    request_poll?: KeyboardButtonPollType

    If specified, the user will be asked to create a poll and send it to the bot. Available in private chats only.

    request_users?: KeyboardButtonRequestUsers

    If specified, pressing the button will open a list of suitable users.

    style?: string

    Style of the button ('danger', 'success', 'primary').

    text

    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.

    web_app?: WebAppInfo

    If specified, the described Web App will be launched when the button is pressed.

    Settings
    Member Visibility

    On This Page
    Properties