MadelineProtoDocs/old_docs/API_docs_v5/methods/contacts.search.md
2020-06-16 17:50:25 +02:00

1.4 KiB

title description image redirect_from
contacts.search Returns users found by username substring. https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png /API_docs/methods/contacts_search.html

Method: contacts.search

Back to methods index

Returns users found by username substring.

Parameters:

Name Type Description Required
q string Target substring Yes
limit int Maximum number of users to be returned Yes

Return type: contacts.Found

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

$contacts.Found = $MadelineProto->contacts->search(['q' => 'string', 'limit' => int, ]);

Or, if you're into Lua:

contacts.Found = contacts.search({q='string', limit=int, })

Errors

Code Type Description
400 QUERY_TOO_SHORT The query string is too short
400 SEARCH_QUERY_EMPTY The search query is empty
-503 Timeout Timeout while fetching data