1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-15 22:36:55 +01:00
MadelineProto/old_docs/API_docs_v51/methods/messages_readHistory.md

73 lines
1.7 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: messages.readHistory
description: messages.readHistory parameters, return type and example
---
2017-01-19 23:02:27 +01:00
## Method: messages.readHistory
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
2018-03-20 16:42:05 +01:00
|max\_id|[CLICK ME int](../types/int.md) | Yes|
### 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';
// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();
$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, })
```