MadelineProto/old_docs/API_docs_v73/methods/contacts_search.md
Daniil Gentili e4a326e552
Http refactor (#307)
* refactor

* Apply fixes from StyleCI

* Implement https and http transport, add support for new req_pq_multi, send pending acks and objects in containers along with the next method call, remove dependency on the socket extension.

* Apply fixes from StyleCI

* Make types with empty constructors optional, fix phar archives (fixes #217)

* Apply fixes from StyleCI

* Update to layer 75

* Update github pages gemfile.lock
2018-02-18 14:18:18 +01:00

1.4 KiB

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

Method: contacts.search

Back to methods index

Parameters:

Name Type Required
q string Yes
limit int Yes

Return type: contacts_Found

Can bots use this method: NO

Errors this method can return:

Error Description
QUERY_TOO_SHORT The query string is too short
SEARCH_QUERY_EMPTY The search query is empty
Timeout A timeout occurred while fetching data from the bot

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

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

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

As a user:

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

Parameters:

q - Json encoded string

limit - Json encoded int

Or, if you're into Lua:

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