Module

x/grammy/mod.ts>Api#restrictChatMember

The Telegram Bot Framework.
grammyjs/grammY
Very Popular
Go to Latest
method Api.prototype.restrictChatMember
import { Api } from "https://dotland.deno.dev/x/grammy@v1.20.2/mod.ts";

Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

Parameters

chat_id: number | string

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

user_id: number

Unique identifier of the target user

permissions: ChatPermissions

An object for new user permissions

optional
other: Other<R, "restrictChatMember", "chat_id" | "user_id" | "permissions">

Optional remaining parameters, confer the official reference below

optional
signal: AbortSignal

Optional AbortSignal to cancel the request

Official reference: https://core.telegram.org/bots/api#restrictchatmember