Skip to content

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 »

Fields

request_idIntegerRequired
Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message
user_is_botBooleanOptional
Optional. Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied.
user_is_premiumBooleanOptional
Optional. Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied.
max_quantityIntegerOptional Default: 1
Optional. The maximum number of users to be selected; 1-10. Defaults to 1.
request_nameBooleanOptional
Optional. Pass True to request the users' first and last names
request_usernameBooleanOptional
Optional. Pass True to request the users' usernames
request_photoBooleanOptional
Optional. Pass True to request the users' photos

GramIO Usage

See Also