Chat.restrict_member()

Chat.restrict_member()

Bound method unban_member of Chat.

Use as a shortcut for:

client.restrict_chat_member(
    chat_id=chat_id,
    user_id=user_id,
    permissions=ChatPermissions()
)

Example

chat.restrict_member(user_id, ChatPermissions())

Parameters

• user_id (int | str) – Unique identifier (int) or username (str) of the target user. For a contact that exists in your Telegram address book you can use his phone number (str).

• permissions (ChatPermissions) – New user permissions.

• until_date (int, optional) – Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Defaults to 0 (ban forever).

Returns

Chat – On success, a chat object is returned.

Raises

RPCError – In case of a Telegram RPC error.