MadelineProtoDocs/old_docs/API_docs_v103/methods/channels.editBanned.md
2019-12-27 17:48:04 +01:00

2.1 KiB

title description image
channels.editBanned Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel). https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Method: channels.editBanned

Back to methods index

Ban/unban/kick a user in a supergroup/channel.

Parameters:

Name Type Description Required
channel Username, chat ID, Update, Message or InputChannel The supergroup/channel. Optional
user_id Username, chat ID, Update, Message or InputUser The ID of the user whose banned rights should be modified Optional
banned_rights ChatBannedRights The banned rights Yes

Return type: Updates

Can bots use this method: YES

MadelineProto Example (now async for huge speed and parallelism!):

if (!file_exists('madeline.php')) {
    copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';

$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();

$Updates = $MadelineProto->channels->editBanned(['channel' => InputChannel, 'user_id' => InputUser, 'banned_rights' => ChatBannedRights, ]);

Or, if you're into Lua:

Updates = channels.editBanned({channel=InputChannel, user_id=InputUser, banned_rights=ChatBannedRights, })

Errors

Code Type Description
400 CHANNEL_INVALID The provided channel is invalid
400 CHANNEL_PRIVATE You haven't joined this channel/supergroup
400 CHAT_ADMIN_REQUIRED You must be an admin in this chat to do this
400 MSG_ID_INVALID Invalid message ID provided
400 PINNED_DIALOGS_TOO_MUCH Too many pinned dialogs
400 USER_ADMIN_INVALID You're not an admin
400 USER_ID_INVALID The provided user ID is invalid
403 CHAT_WRITE_FORBIDDEN You can't write in this chat