MadelineProtoDocs/old_docs/API_docs_v25/methods/messages_deleteChatUser.md

56 lines
1.6 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
2018-04-01 13:24:46 +02:00
### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md)
2018-04-01 13:19:25 +02:00
### Can bots use this method: **YES**
### MadelineProto Example:
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
2019-03-12 13:25:41 +01:00
define('MADELINE_BRANCH', '');
2018-04-01 13:19:25 +02:00
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2018-04-01 13:24:46 +02:00
$messages_StatedMessage = $MadelineProto->messages->deleteChatUser(['chat_id' => InputPeer, 'user_id' => InputUser, ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2018-04-01 13:24:46 +02:00
messages_StatedMessage = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, })
2018-04-01 13:19:25 +02:00
```
### 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|