restrictChatMember#

Returns: bool

class aiogram.methods.restrict_chat_member.RestrictChatMember(*, chat_id: Union[int, str], user_id: int, permissions: aiogram.types.chat_permissions.ChatPermissions, until_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None, **extra_data: Any)[source]#

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. Returns True on success.

Source: https://core.telegram.org/bots/api#restrictchatmember

chat_id: Union[int, str]#

Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

user_id: int#

Unique identifier of the target user

permissions: aiogram.types.chat_permissions.ChatPermissions#

A JSON-serialized object for new user permissions

until_date: Optional[Union[datetime.datetime, datetime.timedelta, int]]#

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

build_request(bot: Bot) Request[source]#

Usage#

As bot method#

result: bool = await bot.restrict_chat_member(...)

Method as object#

Imports:

  • from aiogram.methods.restrict_chat_member import RestrictChatMember

  • alias: from aiogram.methods import RestrictChatMember

With specific bot#

result: bool = await bot(RestrictChatMember(...))

As reply into Webhook in handler#

return RestrictChatMember(...)