MadelineProtoDocs/old_docs/API_docs_v34/methods/channels.deleteHistory.md

56 lines
1.6 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
title: channels.deleteHistory
description: Delete the history of a [supergroup](https://core.telegram.org/api/channel)
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/channels_deleteHistory.html
2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: channels.deleteHistory
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
Delete the history of a [supergroup](https://core.telegram.org/api/channel)
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
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | [Supergroup](https://core.telegram.org/api/channel) whose history must be deleted | Optional|
|max\_id|[int](../types/int.md) | ID of message **up to which** the history must be deleted | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [Bool](../types/Bool.md)
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
$Bool = $MadelineProto->channels->deleteHistory(['channel' => InputChannel, '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
Bool = channels.deleteHistory({channel=InputChannel, max_id=int, })
2018-04-01 13:19:25 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|CHANNEL_INVALID|The provided channel is invalid|
2020-06-16 17:50:25 +02:00
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
2018-04-01 13:19:25 +02:00