MadelineProto/old_docs/API_docs_v23/methods/messages_readHistory.md
2017-12-11 12:12:38 +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 Yes
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, })