MadelineProtoDocs/docs/API_docs/methods/channels_deleteHistory.md

72 lines
1.6 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: channels.deleteHistory
description: Delete the history of a supergroup/channel
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: channels.deleteHistory
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Delete the history of a supergroup/channel
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|max\_id|[int](../types/int.md) | Maximum message ID to delete | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [Bool](../types/Bool.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();
$Bool = $MadelineProto->channels->deleteHistory(['channel' => InputChannel, 'max_id' => int, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - channels.deleteHistory
* params - `{"channel": InputChannel, "max_id": int, }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.deleteHistory`
Parameters:
channel - Json encoded InputChannel
max_id - Json encoded int
Or, if you're into Lua:
```
Bool = channels.deleteHistory({channel=InputChannel, max_id=int, })
```