MadelineProto/old_docs/API_docs_v71/methods/messages_deleteHistory.md

72 lines
1.6 KiB
Markdown
Raw Normal View History

2017-10-14 11:50:46 +02:00
---
title: messages.deleteHistory
2018-03-23 12:35:00 +01:00
description: Delete chat history
2017-10-14 11:50:46 +02:00
---
## Method: messages.deleteHistory
[Back to methods index](index.md)
2018-03-23 12:35:00 +01:00
Delete chat history
2017-10-14 11:50:46 +02:00
### Parameters:
2018-03-23 12:35:00 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-03-27 14:41:50 +02:00
|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side|
2018-03-23 12:35:00 +01:00
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it|
2018-03-27 14:41:50 +02:00
|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete|
2017-10-14 11:50:46 +02:00
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)
### Can bots use this method: **NO**
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
2017-10-14 11:50:46 +02:00
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2017-10-14 11:50:46 +02:00
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2017-10-14 11:50:46 +02:00
$messages_AffectedHistory = $MadelineProto->messages->deleteHistory(['just_clear' => Bool, 'peer' => InputPeer, 'max_id' => int, ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-10-14 11:50:46 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.deleteHistory`
Parameters:
just_clear - Json encoded Bool
peer - Json encoded InputPeer
max_id - Json encoded int
Or, if you're into Lua:
```
messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, })
```
2018-03-27 14:41:50 +02:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PEER_ID_INVALID|The provided peer id is invalid|