closeForumTopic()
Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. 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 |
message_thread_id | number | required | Unique identifier for the target message thread of the forum topic |
returns
boolean
usage in yaebal
closeForumTopic is directly typed on Api — call it straight off bot.api.
import type { CloseForumTopicParams } from "@yaebal/types";
await bot.api.closeForumTopic({
chat_id: 123456789,
message_thread_id: 1,
} satisfies CloseForumTopicParams);context shortcut
also available as ctx.closeForumTopic() on
9
context types — see @yaebal/contexts.
/** Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success. */
ctx.closeForumTopic(params?: Omit<CloseForumTopicParams, "chat_id" | "message_thread_id"> & { message_thread_id?: number })official Bot API docs: https://core.telegram.org/bots/api/#closeforumtopic