1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-14 19:06:55 +01:00
MadelineProto/old_docs/API_docs_v68/methods/channels_editBanned.md

86 lines
2.1 KiB
Markdown
Raw Normal View History

2017-07-23 17:44:01 +02:00
---
title: channels.editBanned
description: channels.editBanned parameters, return type and example
---
## Method: channels.editBanned
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
2017-07-23 17:44:01 +02:00
|channel|[InputChannel](../types/InputChannel.md) | Yes|
|user\_id|[InputUser](../types/InputUser.md) | Yes|
|banned\_rights|[ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|
### Return type: [Updates](../types/Updates.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
2017-11-03 17:39:50 +01:00
### 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|
2017-07-23 17:44:01 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-07-23 17:44:01 +02:00
if (isset($token)) { // Login as a bot
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
2017-07-23 17:44:01 +02:00
$MadelineProto->complete_phone_login($code);
}
$Updates = $MadelineProto->channels->editBanned(['channel' => InputChannel, 'user_id' => InputUser, 'banned_rights' => ChannelBannedRights, ]);
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 17:44:01 +02:00
### 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
2017-08-20 19:09:52 +02:00
2017-07-23 17:44:01 +02:00
user_id - Json encoded InputUser
2017-08-20 19:09:52 +02:00
2017-07-23 17:44:01 +02:00
banned_rights - Json encoded ChannelBannedRights
2017-08-20 19:09:52 +02:00
2017-07-23 17:44:01 +02:00
Or, if you're into Lua:
```
Updates = channels.editBanned({channel=InputChannel, user_id=InputUser, banned_rights=ChannelBannedRights, })
```