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?: boolean;
    request_id: number;
    request_name?: boolean;
    request_photo?: boolean;
    request_username?: boolean;
    user_is_bot?: boolean;
    user_is_remium?: boolean;
}

Properties

max_quantity? request_id request_name? request_photo? request_username? user_is_bot? user_is_remium?

Properties

Optionalmax_quantity

max_quantity?: boolean

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

Optionalrequest_name

request_name?: boolean

Pass True to request the users' first and last names

Optionalrequest_photo

request_photo?: boolean

Pass True to request the users' photos

Optionalrequest_username

request_username?: boolean

Pass True to request the users' usernames

Optionaluser_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.

Optionaluser_is_remium

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

On This Page

Properties