KeyboardButtonRequestUsers

^{ref / types / 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.

^Source

Properties

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

^Source

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.

^Source

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.

^Source

max_quantity

max_quantity?: number;

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

^Source

request_name

request_name?: boolean;

Pass True to request the users’ first and last names

^Source

request_username

request_username?: boolean;

Pass True to request the users’ usernames

^Source

request_photo

request_photo?: boolean;

Pass True to request the users’ photos

^Source