MadelineProtoDocs/old_docs/API_docs_v33/methods/messages_readHistory.md

74 lines
1.7 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.readHistory
description: Mark messages as read
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: messages.readHistory
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Mark messages as read
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional|
|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes|
|offset|[int](../types/int.md) | Offset | Yes|
2018-04-01 13:19:25 +02:00
2018-04-01 13:24:46 +02:00
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)
2018-04-01 13:19:25 +02:00
### Can bots use this method: **NO**
### MadelineProto Example:
```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();
2018-04-01 13:24:46 +02:00
$messages_AffectedHistory = $MadelineProto->messages->readHistory(['peer' => InputPeer, 'max_id' => int, '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.readHistory`
Parameters:
peer - Json encoded InputPeer
max_id - Json encoded int
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:
```lua
2018-04-01 13:24:46 +02:00
messages_AffectedHistory = messages.readHistory({peer=InputPeer, max_id=int, 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|
|Timeout|A timeout occurred while fetching data from the bot|