Method: messages.search

Back to methods index

Search peers or messages

Parameters:

Name Type Description Required
peer Username, chat ID, Update, Message or InputPeer Where to search Optional
q string What to search Yes
from_id Username, chat ID, Update, Message or InputUser Show only messages from a certain user? Optional
filter MessagesFilter Message filter Optional
min_date int Minumum date of results to fetch Yes
max_date int Maximum date of results to fetch Yes
offset_id int Message ID offset Yes
add_offset int Additional offset, can be 0 Yes
limit int Number of results to return Yes
max_id int Maximum message id to return Yes
min_id int Minumum message id to return Yes
hash Array of int The IDs of messages you already fetched Optional

Return type: messages_Messages

Can bots use this method: NO

MadelineProto Example:

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_Messages = $MadelineProto->messages->search(['peer' => InputPeer, 'q' => 'string', 'from_id' => InputUser, 'filter' => MessagesFilter, 'min_date' => int, 'max_date' => int, 'offset_id' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, 'hash' => [int, int], ]);

PWRTelegram HTTP API example (NOT FOR MadelineProto):

As a user:

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

Parameters:

peer - Json encoded InputPeer

q - Json encoded string

from_id - Json encoded InputUser

filter - Json encoded MessagesFilter

min_date - Json encoded int

max_date - Json encoded int

offset_id - Json encoded int

add_offset - Json encoded int

limit - Json encoded int

max_id - Json encoded int

min_id - Json encoded int

hash - Json encoded array of int

Or, if you’re into Lua:

messages_Messages = messages.search({peer=InputPeer, q='string', from_id=InputUser, filter=MessagesFilter, min_date=int, max_date=int, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, hash={int}, })

Errors this method can return:

Error Description
CHAT_ADMIN_REQUIRED You must be an admin in this chat to do this
INPUT_CONSTRUCTOR_INVALID The provided constructor is invalid
INPUT_USER_DEACTIVATED The specified user was deleted
PEER_ID_INVALID The provided peer id is invalid
PEER_ID_NOT_SUPPORTED The provided peer ID is not supported
SEARCH_QUERY_EMPTY The search query is empty
USER_ID_INVALID The provided user ID is invalid