MadelineProto/old_docs/API_docs_v71/methods/messages_readHistory.md

68 lines
1.5 KiB
Markdown
Raw Normal View History

2017-10-14 11:50:46 +02:00
---
title: messages.readHistory
description: messages.readHistory parameters, return type and example
---
## Method: messages.readHistory
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|peer|[InputPeer](../types/InputPeer.md) | Optional|
2017-10-14 11:50:46 +02:00
|max\_id|[int](../types/int.md) | Yes|
### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md)
### 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
2017-10-14 11:50:46 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-10-14 11:50:46 +02:00
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-10-14 11:50:46 +02:00
$MadelineProto->complete_phone_login($code);
}
$messages_AffectedMessages = $MadelineProto->messages->readHistory(['peer' => InputPeer, 'max_id' => int, ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.readHistory`
Parameters:
peer - Json encoded InputPeer
max_id - Json encoded int
Or, if you're into Lua:
```
messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, })
```