GramIO API Reference / gramio/dist / TelegramKeyboardButtonRequestChat
Interface: TelegramKeyboardButtonRequestChat
Defined in: @gramio/types/out/objects.d.ts:3125
This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats ».
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
bot_administrator_rights? | TelegramChatAdministratorRights | Optional. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3153 |
bot_is_member? | boolean | Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3157 |
chat_has_username? | boolean | Optional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3141 |
chat_is_channel | boolean | Pass True to request a channel chat, pass False to request a group or a supergroup chat. | @gramio/types/out/objects.d.ts:3133 |
chat_is_created? | boolean | Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3145 |
chat_is_forum? | boolean | Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3137 |
request_id | number | Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message | @gramio/types/out/objects.d.ts:3129 |
request_photo? | boolean | Optional. Pass True to request the chat's photo | @gramio/types/out/objects.d.ts:3169 |
request_title? | boolean | Optional. Pass True to request the chat's title | @gramio/types/out/objects.d.ts:3161 |
request_username? | boolean | Optional. Pass True to request the chat's username | @gramio/types/out/objects.d.ts:3165 |
user_administrator_rights? | TelegramChatAdministratorRights | Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied. | @gramio/types/out/objects.d.ts:3149 |