Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/grammy/mod.ts>Api#banChatMember

The Telegram Bot Framework.
grammyjs/grammY
Very Popular
Latest
method Api.prototype.banChatMember
import { Api } from "https://deno.land/x/grammy@v1.31.0/mod.ts";

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters

chat_id: number | string

Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)

user_id: number

Unique identifier of the target user

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

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#banchatmember