MadelineProtoDocs/docs/API_docs/methods/channels_editBanned.md
Sean 4baac3178e Add Syntax Highlight for Markdown
Add PHP, Lua language tag to Code area
2018-10-18 00:30:20 +08:00

2.3 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');
}
include 'madeline.php';

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

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

PWRTelegram HTTP API example (NOT FOR MadelineProto):

As a bot:

POST/GET to https://api.pwrtelegram.xyz/botTOKEN/madeline

Parameters:

  • method - channels.editBanned
  • params - {"channel": InputChannel, "user_id": InputUser, "banned_rights": ChannelBannedRights, }

As a user:

POST/GET to https://api.pwrtelegram.xyz/userTOKEN/channels.editBanned

Parameters:

channel - Json encoded InputChannel

user_id - Json encoded InputUser

banned_rights - Json encoded 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