Link Search Menu Expand Document

Method: messages.search

Back to methods index

Returns found messages

Parameters:

NameTypeDescriptionRequired
peerUsername, chat ID, Update, Message or InputPeerUser or chat, histories with which are searched, or (inputPeerEmpty) constructor for global searchOptional
qstringText search requestYes
from_idUsername, chat ID, Update, Message or InputPeerOnly return messages sent by the specified user IDOptional
top_msg_idintThread IDOptional
filterMessagesFilterFilter to return only specified message typesOptional
min_dateintIf a positive value was transferred, only messages with a sending date bigger than the transferred one will be returnedOptional
max_dateintIf a positive value was transferred, only messages with a sending date smaller than the transferred one will be returnedOptional
offset_idintOnly return messages starting from the specified message IDOptional
add_offsetintAdditional offsetOptional
limitintNumber of results to returnOptional
max_idintMaximum message ID to returnOptional
min_idintMinimum message ID to returnOptional
hashArray of longHashOptional

Return type: messages.Messages

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();

// PHP 8+ syntax, use an array on PHP 7.
$messages_Messages = $MadelineProto->messages->search(peer: InputPeer, q: 'string', from_id: InputPeer, top_msg_id: int, filter: MessagesFilter, min_date: int, max_date: int, offset_id: int, add_offset: int, limit: int, max_id: int, min_id: int, hash: [long, long], );