MadelineProtoDocs/old_docs/API_docs_v55/methods/messages_deleteChatUser.md

81 lines
1.9 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.deleteChatUser
description: Delete a user from a chat (not supergroup)
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: messages.deleteChatUser
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Delete a user from a chat (not supergroup)
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional|
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();
$Updates = $MadelineProto->messages->deleteChatUser(['chat_id' => InputPeer, 'user_id' => InputUser, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - messages.deleteChatUser
* params - `{"chat_id": InputPeer, "user_id": InputUser, }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.deleteChatUser`
Parameters:
chat_id - Json encoded InputPeer
user_id - Json encoded InputUser
Or, if you're into Lua:
```
Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHAT_ID_INVALID|The provided chat id is invalid|
|PEER_ID_INVALID|The provided peer id is invalid|
|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel|