unbanChatMember()
Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
parameters
| parameter | type | required | description |
|---|---|---|---|
chat_id | number | string | required | Unique identifier for the target group or username of the target supergroup or channel in the format @username |
user_id | number | required | Unique identifier of the target user |
only_if_banned | boolean | optional | Do nothing if the user is not banned |
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 { UnbanChatMemberParams } from "@yaebal/types";
await bot.api.call<boolean>("unbanChatMember", {
chat_id: 123456789,
user_id: 123456789,
} satisfies UnbanChatMemberParams);context shortcut
also available as ctx.unbanChatMember() on
11
context types — see @yaebal/contexts.
/** Use this method to unban a previously banned user in a supergroup or channel. The user will **not** return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be **removed** from the chat. If you don't want this, use the parameter *only\_if\_banned*. Returns *True* on success. */
ctx.unbanChatMember(params: Omit<UnbanChatMemberParams, "chat_id" | "user_id">)official Bot API docs: https://core.telegram.org/bots/api/#unbanchatmember