59 lines
1.9 KiB
Markdown
59 lines
1.9 KiB
Markdown
|
---
|
||
|
|
title: channels.editBanned
|
||
|
|
description: Kick or ban a user from a channel/supergroup
|
||
|
|
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||
|
|
---
|
||
|
|
# Method: channels.editBanned
|
||
|
|
[Back to methods index](index.md)
|
||
|
|
|
||
|
|
|
||
|
|
Kick or ban a user from a channel/supergroup
|
||
|
|
|
||
|
|
### Parameters:
|
||
|
|
|
||
|
|
| Name | Type | Description | Required |
|
||
|
|
|----------|---------------|-------------|----------|
|
||
|
|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|
||
|
|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to kick/ban | Optional|
|
||
|
|
|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Banned rights | Yes|
|
||
|
|
|
||
|
|
|
||
|
|
### Return type: [Updates](../types/Updates.md)
|
||
|
|
|
||
|
|
### Can bots use this method: **YES**
|
||
|
|
|
||
|
|
|
||
|
|
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
|
||
|
|
|
||
|
|
|
||
|
|
```php
|
||
|
|
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:
|
||
|
|
|
||
|
|
```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|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|
|
||
|
|
|
||
|
|
|