GramIO API Reference / gramio/dist / TelegramKeyboardButtonRequestUsers
Interface: TelegramKeyboardButtonRequestUsers
Defined in: @gramio/types/out/objects.d.ts:3089
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 »
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
max_quantity? | number | Optional. The maximum number of users to be selected; 1-10. Defaults to 1. | @gramio/types/out/objects.d.ts:3105 |
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 | @gramio/types/out/objects.d.ts:3093 |
request_name? | boolean | Optional. Pass True to request the users' first and last names | @gramio/types/out/objects.d.ts:3109 |
request_photo? | boolean | Optional. Pass True to request the users' photos | @gramio/types/out/objects.d.ts:3117 |
request_username? | boolean | Optional. Pass True to request the users' usernames | @gramio/types/out/objects.d.ts:3113 |
user_is_bot? | boolean | Optional. Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3097 |
user_is_premium? | boolean | Optional. Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3101 |