MadelineProtoDocs/old_docs/API_docs_v75/methods/channels_editBanned.md

1.8 KiB

title description image
channels.editBanned Kick or ban a user from a channel/supergroup https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Method: channels.editBanned

Back to methods index

Kick or ban a user from a channel/supergroup

Parameters:

Name Type Description Required
channel Username, chat ID, Update, Message or InputChannel The channel/supergroup Optional
user_id Username, chat ID, Update, Message or InputUser The user to kick/ban Optional
banned_rights ChannelBannedRights Banned/kicked permissions Yes

Return type: Updates

Can bots use this method: YES

MadelineProto Example:

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

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

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

Or, if you're into Lua:

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

Errors this method can return:

Error Description
CHANNEL_INVALID The provided channel is invalid
CHANNEL_PRIVATE You haven't joined this channel/supergroup
CHAT_ADMIN_REQUIRED You must be an admin in this chat to do this
USER_ADMIN_INVALID You're not an admin
USER_ID_INVALID The provided user ID is invalid