1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-11 12:39:37 +01:00
MadelineProto/old_docs/API_docs_v23/methods/messages_readHistory.md
2018-03-23 11:35:00 +00:00

2.0 KiB

title description
messages.readHistory Mark messages as read

Method: messages.readHistory

Back to methods index

Mark messages as read

Parameters:

Name Type Required Description
peer Username, chat ID, Update, Message or InputPeer Optional Where to mark messages as read
max_id CLICK ME int Yes Maximum message ID to mark as read
offset CLICK ME int Yes
read_contents CLICK ME 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

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_AffectedHistory = $MadelineProto->messages->readHistory(['peer' => InputPeer, 'max_id' => int, 'offset' => int, 'read_contents' => Bool, ]);

PWRTelegram HTTP API example (NOT FOR MadelineProto):

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, })