setChatPermissions()
Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.
parameters
| parameter | type | required | description |
|---|---|---|---|
chat_id | number | string | required | Unique identifier for the target chat or username of the target supergroup in the format @username |
permissions | ChatPermissions | required | A JSON-serialized object for new default chat permissions |
use_independent_chat_permissions | boolean | optional | 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. |
returns
boolean
usage in yaebal
not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.
import type { SetChatPermissionsParams } from "@yaebal/types";
await bot.api.call<boolean>("setChatPermissions", {
chat_id: 123456789,
permissions: {} /* ChatPermissions */,
} satisfies SetChatPermissionsParams);context shortcut
also available as ctx.setChatPermissions() on
16
context types — see @yaebal/contexts.
/** Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the *can\_restrict\_members* administrator rights. Returns *True* on success. */
ctx.setChatPermissions(params: Omit<SetChatPermissionsParams, "chat_id">)official Bot API docs: https://core.telegram.org/bots/api/#setchatpermissions