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

    Interface KeyboardButtonRequestUsers

    Defines the criteria used to request suitable users.

    Telegram Bot API: KeyboardButtonRequestUsers

    interface KeyboardButtonRequestUsers {
        max_quantity?: number;
        request_id: number;
        request_name?: boolean;
        request_photo?: boolean;
        request_username?: boolean;
        user_is_bot?: boolean;
        user_is_premium?: boolean;
    }
    Index
    max_quantity? request_id request_name? request_photo? request_username? user_is_bot? user_is_premium?
    max_quantity?: number

    The maximum number of users to be selected; 1-10. Defaults to 1.

    request_id: number

    Signed 32-bit identifier of the request that will be received back in the UserShared object.

    request_name?: boolean

    Pass True to request the users' first and last name.

    request_photo?: boolean

    Pass True to request the users' photo.

    request_username?: boolean

    Pass True to request the users' username.

    user_is_bot?: boolean

    Pass True to request bots, pass False to request regular users.

    user_is_premium?: boolean

    Pass True to request premium users, pass False to request non-premium users.

    Settings
    Member Visibility

    On This Page
    Properties