restrictChatMember
Returns boolean ↗
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.
Required: chat_id, user_id, permissions · 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("restrict_chat_member", { chat_id: "YOUR_CHAT_ID", user_id: 0, permissions: { /* ChatPermissions */ }})Parameters
chat_id number | string Required
Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).
user_id number Required
Unique identifier of the target user.
permissions ChatPermissions Required
A JSON-serialized object for new user permissions.
use_independent_chat_permissions boolean
Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.
until_date number
Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever.