banChatMember
Returns boolean ↗
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.
Required: chat_id, user_id · Optional: 2 parameters
Try it
TypeScript example · @effect-ak/tg-bot-client
import { makeTgBotClient } from "@effect-ak/tg-bot-client"
const client = makeTgBotClient({ bot_token: "YOUR_BOT_TOKEN" })
const result = await client.execute("ban_chat_member", { chat_id: "YOUR_CHAT_ID", user_id: 0})Parameters
chat_id number | string Required
Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername).
user_id number Required
Unique identifier of the target user.
until_date number
Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.
revoke_messages boolean
Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.