MadelineProto/old_docs/API_docs_v72/methods/messages_deleteMessages.md

79 lines
1.8 KiB
Markdown
Raw Normal View History

2017-11-15 13:41:58 +01:00
---
title: messages.deleteMessages
description: messages.deleteMessages parameters, return type and example
---
## Method: messages.deleteMessages
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|revoke|[Bool](../types/Bool.md) | Optional|
|id|Array of [int](../types/int.md) | Yes|
### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-11-15 13:41:58 +01:00
if (isset($token)) { // Login as a bot
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
2017-11-15 13:41:58 +01:00
$MadelineProto->complete_phone_login($code);
}
$messages_AffectedMessages = $MadelineProto->messages->deleteMessages(['revoke' => Bool, 'id' => [int], ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - messages.deleteMessages
* params - `{"revoke": Bool, "id": [int], }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.deleteMessages`
Parameters:
revoke - Json encoded Bool
id - Json encoded array of int
Or, if you're into Lua:
```
messages_AffectedMessages = messages.deleteMessages({revoke=Bool, id={int}, })
```