MadelineProto/docs/API_docs/methods/messages_readHistory.md

70 lines
1.5 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
title: messages.readHistory
2018-03-23 12:35:00 +01:00
description: Mark messages as read
2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
## Method: messages.readHistory
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
2018-03-23 12:35:00 +01:00
Mark messages as read
### Parameters:
2018-03-23 12:35:00 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read|
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read|
2016-12-19 18:35:27 +01:00
### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PEER_ID_INVALID|The provided peer id is invalid|
2017-11-08 13:04:40 +01:00
|Timeout|A timeout occurred while fetching data from the bot|
2017-11-03 17:39:50 +01:00
2018-03-20 19:57:36 +01:00
### 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();
2016-12-21 10:40:30 +01:00
$messages_AffectedMessages = $MadelineProto->messages->readHistory(['peer' => InputPeer, 'max_id' => int, ]);
2017-02-13 04:33:06 +01:00
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.readHistory`
Parameters:
peer - Json encoded InputPeer
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
max_id - Json encoded int
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, })
```