MadelineProto/old_docs/API_docs_v45/methods/messages_search.md
2017-12-11 12:12:38 +01:00

2.5 KiB

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

Method: messages.search

Back to methods index

Parameters:

Name Type Required
important_only Bool Optional
peer InputPeer Yes
q string Yes
filter MessagesFilter Yes
min_date int Yes
max_date int Yes
offset int Yes
max_id int Yes
limit 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

Example:

$MadelineProto = new \danog\MadelineProto\API();
$MadelineProto->session = 'mySession.madeline';
if (isset($number)) { // Login as a user
    $MadelineProto->phone_login($number);
    $code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
    $MadelineProto->complete_phone_login($code);
}

$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, ]);

Or, if you're using the PWRTelegram HTTP API:

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