restrictChatMember

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.

Arguments
Name Type Description Required
permissions chatPermissions | array | stdClass A JSON-serialized object for new user permissions yes
chat_id int | string | null Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) no
user_id int | null Unique identifier of the target user no
use_independent_chat_permissions bool | null Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. no
until_date int | null 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 no
token string | null You can use this method on another bot with specify this parameter no
forgot bool | null You can set to not receive request result, dont set it or pass null for turn it off no
answer bool | null You can set to answer to webhook, dont set it or pass null for turn it off no

Output : bool | BPT\types\responseError

Static or normal : Static

Examples :

request::restrictChatMember(permissions: ChatPermissions, chat_id: int | string | null, user_id: int | null, use_independent_chat_permissions: bool | null, until_date: int | null, token: String | null, forgot: Boolean | null, answer: Boolean | null);
request::restrictChatMember(['permissions' => ChatPermissions, 'chat_id' => int | string | null, 'user_id' => int | null, 'use_independent_chat_permissions' => bool | null, 'until_date' => int | null, 'token' => String | null, 'forgot' => Boolean | null, 'answer' => Boolean | null]);
request::restrictChatMember(permissions: ChatPermissions);
request::restrictChatMember(['permissions' => ChatPermissions]);