MadelineProto/old_docs/API_docs_v51/methods/messages_search.md

title	description
messages.search	messages.search parameters, return type and example

Method: messages.search

Back to methods index

Parameters:

Name	Type	Required
important_only	CLICK ME Bool	Optional
peer	Username, chat ID, Update, Message or InputPeer	Optional
q	CLICK ME string	Yes
filter	CLICK ME MessagesFilter	Yes
min_date	CLICK ME int	Yes
max_date	CLICK ME int	Yes
offset	CLICK ME int	Yes
max_id	CLICK ME int	Yes
limit	CLICK ME int	Yes

Return type: messages_Messages

Can bots use this method: NO

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

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_Messages = $MadelineProto->messages->search(['important_only' => Bool, 'peer' => InputPeer, 'q' => 'string', 'filter' => MessagesFilter, 'min_date' => int, 'max_date' => int, 'offset' => int, 'max_id' => int, 'limit' => int, ]);

PWRTelegram HTTP API example (NOT FOR MadelineProto):

As a user:

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

Parameters:

important_only - Json encoded Bool

peer - Json encoded InputPeer

q - Json encoded string

filter - Json encoded MessagesFilter

min_date - Json encoded int

max_date - Json encoded int

offset - Json encoded int

max_id - Json encoded int

limit - Json encoded int

Or, if you're into Lua:

messages_Messages = messages.search({important_only=Bool, peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, })