MadelineProto/old_docs/API_docs_v55/methods/channels_kickFromChannel.md

77 lines
1.8 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: channels.kickFromChannel
description: channels.kickFromChannel parameters, return type and example
---
2017-01-19 23:02:27 +01:00
## Method: channels.kickFromChannel
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|
2018-03-20 16:42:05 +01:00
|kicked|[CLICK ME Bool](../types/Bool.md) | Yes|
### Return type: [Updates](../types/Updates.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
### Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();
$Updates = $MadelineProto->channels->kickFromChannel(['channel' => InputChannel, 'user_id' => InputUser, 'kicked' => Bool, ]);
2017-02-13 04:33:06 +01:00
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 16:11:02 +02:00
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - channels.kickFromChannel
2017-07-23 16:40:54 +02:00
* params - `{"channel": InputChannel, "user_id": InputUser, "kicked": Bool, }`
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.kickFromChannel`
Parameters:
channel - Json encoded InputChannel
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
user_id - Json encoded InputUser
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
kicked - Json encoded Bool
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
Updates = channels.kickFromChannel({channel=InputChannel, user_id=InputUser, kicked=Bool, })
```