Module

x/grammy/types.deno.ts>KeyboardButtonRequestUsers

The Telegram Bot Framework.
grammyjs/grammY
Very Popular
Latest
interface KeyboardButtonRequestUsers
import { type KeyboardButtonRequestUsers } from "https://dotland.deno.dev/x/grammy@v1.31.3/types.deno.ts";

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.

Properties

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

optional
user_is_bot: boolean

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

optional
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.

optional
max_quantity: number

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

optional
request_name: boolean

Pass True to request the users' first and last names

optional
request_username: boolean

Pass True to request the users' usernames

optional
request_photo: boolean

Pass True to request the users' photos