leaveChat()
Use this method for your bot to leave a group, supergroup or channel. 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 or channel in the format @username. Channel direct messages chats aren't supported; leave the corresponding channel instead. |
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 { LeaveChatParams } from "@yaebal/types";
await bot.api.call<boolean>("leaveChat", {
chat_id: 123456789,
} satisfies LeaveChatParams);context shortcut
also available as ctx.leaveChat() on
16
context types — see @yaebal/contexts.
/** Use this method for your bot to leave a group, supergroup or channel. Returns *True* on success. */
ctx.leaveChat(params?: Omit<LeaveChatParams, "chat_id">)official Bot API docs: https://core.telegram.org/bots/api/#leavechat