MadelineProto/old_docs/API_docs_v18/methods/messages_readHistory.md
Daniil Gentili e4a326e552
Http refactor (#307)
* refactor

* Apply fixes from StyleCI

* Implement https and http transport, add support for new req_pq_multi, send pending acks and objects in containers along with the next method call, remove dependency on the socket extension.

* Apply fixes from StyleCI

* Make types with empty constructors optional, fix phar archives (fixes #217)

* Apply fixes from StyleCI

* Update to layer 75

* Update github pages gemfile.lock
2018-02-18 14:18:18 +01:00

1.7 KiB

title description
messages.readHistory messages.readHistory parameters, return type and example

Method: messages.readHistory

Back to methods index

Parameters:

Name Type Required
peer InputPeer Optional
max_id int Yes
offset int Yes
read_contents Bool Yes

Return type: messages_AffectedHistory

Can bots use this method: NO

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

Example:

$MadelineProto = new \danog\MadelineProto\API();
$MadelineProto->session = 'mySession.madeline';
if (isset($number)) { // Login as a user
    $MadelineProto->phone_login($number);
    $code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
    $MadelineProto->complete_phone_login($code);
}

$messages_AffectedHistory = $MadelineProto->messages->readHistory(['peer' => InputPeer, 'max_id' => int, 'offset' => int, 'read_contents' => Bool, ]);

Or, if you're using the PWRTelegram HTTP API:

As a user:

POST/GET to https://api.pwrtelegram.xyz/userTOKEN/messages.readHistory

Parameters:

peer - Json encoded InputPeer

max_id - Json encoded int

offset - Json encoded int

read_contents - Json encoded Bool

Or, if you're into Lua:

messages_AffectedHistory = messages.readHistory({peer=InputPeer, max_id=int, offset=int, read_contents=Bool, })