MadelineProtoDocs/old_docs/API_docs_v10/methods/messages.deleteHistory.md

60 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
title: messages.deleteHistory
description: Deletes communication history.
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2020-06-16 17:50:25 +02:00
redirect_from: /API_docs/methods/messages_deleteHistory.html
2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: messages.deleteHistory
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
Deletes communication history.
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2020-06-16 17:50:25 +02:00
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | User or chat, communication history of which will be deleted | Optional|
|max\_id|[int](../types/int.md) | Maximum ID of message to delete | Yes|
2018-04-01 13:19:25 +02:00
2020-06-16 17:50:25 +02:00
### Return type: [messages.AffectedHistory](../types/messages.AffectedHistory.md)
2018-04-01 13:19:25 +02:00
2020-06-16 17:50:25 +02:00
### Can bots use this method: **NO**
2018-04-01 13:19:25 +02:00
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
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();
2020-06-16 17:50:25 +02:00
$messages.AffectedHistory = $MadelineProto->messages->deleteHistory(['peer' => InputPeer, 'max_id' => int, ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2020-06-16 17:50:25 +02:00
messages.AffectedHistory = messages.deleteHistory({peer=InputPeer, max_id=int, })
2018-04-01 13:19:25 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
| Code | Type | Description |
|------|----------|---------------|
2020-09-12 12:47:38 +02:00
|400|CHAT_ID_INVALID|The provided chat id is invalid|
2019-09-02 17:41:28 +02:00
|400|MESSAGE_ID_INVALID|The provided message id is invalid|
2020-06-16 17:50:25 +02:00
|400|MSG_ID_INVALID|Invalid message ID provided|
2019-09-02 17:41:28 +02:00
|400|PEER_ID_INVALID|The provided peer id is invalid|
2020-09-12 12:47:38 +02:00
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
|-503|Timeout|Timeout while fetching data|
2018-04-01 13:19:25 +02:00