ultra-telegram-framework
    Preparing search index...

    Interface KeyboardButtonRequestUsers

    This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. More about requesting users: https://core.telegram.org/bots/features#chat-and-user-selection

    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

    Properties

    max_quantity? request_id request_name? request_photo? request_username? user_is_bot? user_is_premium?

    Properties

    max_quantity?: number

    Optional. 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 UsersShared object. Must be unique within the message

    request_name?: boolean

    Optional. Pass True to request the users' first and last names

    request_photo?: boolean

    Optional. Pass True to request the users' photos

    request_username?: boolean

    Optional. Pass True to request the users' usernames

    user_is_bot?: boolean

    Optional. Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied.

    user_is_premium?: boolean

    Optional. Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied.

    Settings

    Member Visibility

    On This Page

    Properties