MadelineProtoDocs/old_docs/API_docs_v55/methods/channels_kickFromChannel.md

75 lines
1.7 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2018-04-01 13:24:46 +02:00
title: channels.kickFromChannel
description: Kick user from channel
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: channels.kickFromChannel
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2018-04-01 13:24:46 +02:00
Kick user from channel
2018-04-01 13:19:25 +02:00
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
2018-04-01 13:24:46 +02:00
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick|
|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?|
2018-04-01 13:19:25 +02:00
### Return type: [Updates](../types/Updates.md)
### 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();
2018-04-01 13:24:46 +02:00
$Updates = $MadelineProto->channels->kickFromChannel(['channel' => InputChannel, 'user_id' => InputUser, 'kicked' => Bool, ]);
2018-04-01 13:19:25 +02:00
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
2018-04-01 13:24:46 +02:00
* method - channels.kickFromChannel
* params - `{"channel": InputChannel, "user_id": InputUser, "kicked": Bool, }`
2018-04-01 13:19:25 +02:00
### As a user:
2018-04-01 13:24:46 +02:00
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.kickFromChannel`
2018-04-01 13:19:25 +02:00
Parameters:
channel - Json encoded InputChannel
2018-04-01 13:24:46 +02:00
user_id - Json encoded InputUser
kicked - Json encoded Bool
2018-04-01 13:19:25 +02:00
Or, if you're into Lua:
```
2018-04-01 13:24:46 +02:00
Updates = channels.kickFromChannel({channel=InputChannel, user_id=InputUser, kicked=Bool, })
2018-04-01 13:19:25 +02:00
```