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 {
    maxQuantity?: boolean;
    requestId: number;
    requestName?: boolean;
    requestPhoto?: boolean;
    requestUsername?: boolean;
    userIsBot?: boolean;
    userIsPremium?: boolean;
}

Properties

maxQuantity? requestId requestName? requestPhoto? requestUsername? userIsBot? userIsPremium?

Properties

OptionalmaxQuantity

maxQuantity?: boolean

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

requestId

requestId: number

Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message

OptionalrequestName

requestName?: boolean

Pass True to request the users' first and last names

OptionalrequestPhoto

requestPhoto?: boolean

Pass True to request the users' photos

OptionalrequestUsername

requestUsername?: boolean

Pass True to request the users' usernames

OptionaluserIsBot

userIsBot?: boolean

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

OptionaluserIsPremium

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