2016-12-30 16:32:25 +01:00
|
|
|
---
|
2017-01-19 23:02:27 +01:00
|
|
|
title: messages.readHistory
|
|
|
|
description: messages.readHistory parameters, return type and example
|
2016-12-30 16:32:25 +01:00
|
|
|
---
|
2017-01-19 23:02:27 +01:00
|
|
|
## Method: messages.readHistory
|
2016-12-30 16:32:25 +01:00
|
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
|
|
|
|
|
|
### Parameters:
|
|
|
|
|
|
|
|
| Name | Type | Required |
|
|
|
|
|----------|:-------------:|---------:|
|
2017-03-11 19:54:51 +01:00
|
|
|
|peer|[InputPeer](../types/InputPeer.md) | Yes|
|
|
|
|
|max\_id|[int](../types/int.md) | Yes|
|
|
|
|
|offset|[int](../types/int.md) | Yes|
|
|
|
|
|read\_contents|[Bool](../types/Bool.md) | Yes|
|
2016-12-30 16:32:25 +01:00
|
|
|
|
|
|
|
|
Added docs for layer 18, 23, 25, 27, 33, 38, 40, 41, 42, 44, 45, 46, 51, 53, 55
2017-01-02 21:04:36 +01:00
|
|
|
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)
|
2016-12-30 16:32:25 +01:00
|
|
|
|
|
|
|
### Example:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
$MadelineProto = new \danog\MadelineProto\API();
|
2017-04-10 13:49:32 +02:00
|
|
|
if (isset($token)) { // Login as a bot
|
2017-06-19 18:56:47 +02:00
|
|
|
$MadelineProto->bot_login($token);
|
2016-12-30 16:32:25 +01:00
|
|
|
}
|
2017-04-10 13:49:32 +02:00
|
|
|
if (isset($number)) { // Login as a user
|
2016-12-30 16:32:25 +01:00
|
|
|
$sentCode = $MadelineProto->phone_login($number);
|
|
|
|
echo 'Enter the code you received: ';
|
|
|
|
$code = '';
|
|
|
|
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
|
|
|
|
$code .= fgetc(STDIN);
|
|
|
|
}
|
|
|
|
$MadelineProto->complete_phone_login($code);
|
|
|
|
}
|
|
|
|
|
Added docs for layer 18, 23, 25, 27, 33, 38, 40, 41, 42, 44, 45, 46, 51, 53, 55
2017-01-02 21:04:36 +01:00
|
|
|
$messages_AffectedHistory = $MadelineProto->messages->readHistory(['peer' => InputPeer, 'max_id' => int, 'offset' => int, 'read_contents' => Bool, ]);
|
2017-02-13 04:33:06 +01:00
|
|
|
```
|
2017-03-11 19:54:51 +01:00
|
|
|
|
2017-07-23 16:11:02 +02:00
|
|
|
Or, if you're using [PWRTelegram](https://pwrtelegram.xyz):
|
|
|
|
|
|
|
|
### As a bot:
|
|
|
|
|
|
|
|
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
|
|
* method - messages.readHistory
|
2017-07-23 16:33:46 +02:00
|
|
|
* params - {"peer": InputPeer, "max_id": int, "offset": int, "read_contents": Bool, }
|
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:
|
|
|
|
|
2017-07-23 16:35:53 +02:00
|
|
|
```
|
2017-07-23 16:11:02 +02:00
|
|
|
peer - Json encoded InputPeer
|
|
|
|
max_id - Json encoded int
|
|
|
|
offset - Json encoded int
|
|
|
|
read_contents - Json encoded Bool
|
|
|
|
|
|
|
|
```
|
|
|
|
|
2017-03-11 19:54:51 +01:00
|
|
|
Or, if you're into Lua:
|
|
|
|
|
|
|
|
```
|
|
|
|
messages_AffectedHistory = messages.readHistory({peer=InputPeer, max_id=int, offset=int, read_contents=Bool, })
|
|
|
|
```
|
|
|
|
|