MadelineProtoDocs/old_docs/API_docs_v33/methods/messages_deleteHistory.md

70 lines
1.5 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.deleteHistory
description: Delete chat history
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
---
## Method: messages.deleteHistory
[Back to methods index](index.md)
Delete chat history
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it|
2018-04-01 13:24:46 +02:00
|offset|[int](../types/int.md) | Yes|Offset|
2018-04-01 13:19:25 +02:00
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)
### Can bots use this method: **NO**
### 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();
2018-04-01 13:24:46 +02:00
$messages_AffectedHistory = $MadelineProto->messages->deleteHistory(['peer' => InputPeer, 'offset' => int, ]);
2018-04-01 13:19:25 +02:00
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.deleteHistory`
Parameters:
peer - Json encoded InputPeer
2018-04-01 13:24:46 +02:00
offset - Json encoded int
2018-04-01 13:19:25 +02:00
Or, if you're into Lua:
```
2018-04-01 13:24:46 +02:00
messages_AffectedHistory = messages.deleteHistory({peer=InputPeer, offset=int, })
2018-04-01 13:19:25 +02:00
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PEER_ID_INVALID|The provided peer id is invalid|