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.

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;
}

Properties

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

Properties

Optional max_quantity

max_quantity?: number

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

request_id

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

Optional request_name

request_name?: boolean

Pass True to request the users' first and last names

Optional request_photo

request_photo?: boolean

Pass True to request the users' photos

Optional request_username

request_username?: boolean

Pass True to request the users' usernames

Optional user_is_bot

user_is_bot?: boolean

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

Optional user_is_premium

user_is_premium?: boolean

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

Settings

Member Visibility

Theme

On This Page

max_quantityrequest_idrequest_namerequest_photorequest_usernameuser_is_botuser_is_premium