MadelineProtoDocs/old_docs/API_docs_v23/methods/messages.readHistory.md

title	description	image	redirect_from
messages.readHistory	Marks message history as read.	https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png	/API_docs/methods/messages_readHistory.html

Method: messages.readHistory

Back to methods index

Marks message history as read.

Parameters:

Name	Type	Description	Required
peer	Username, chat ID, Update, Message or InputPeer	Target user or group	Optional
max_id	int	If a positive value is passed, only messages with identifiers less or equal than the given one will be read	Yes
offset	int	Offset	Yes
read_contents	Bool	Mark messages as read?	Yes

Return type: messages.AffectedHistory

Can bots use this method: NO

MadelineProto Example (now async for huge speed and parallelism!):

if (!file_exists('madeline.php')) {
    copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';

$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();

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

Or, if you're into Lua:

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

Errors

Code	Type	Description
400	MSG_ID_INVALID	Invalid message ID provided
400	PEER_ID_INVALID	The provided peer id is invalid
-503	Timeout	Timeout while fetching data