MadelineProtoDocs/old_docs/API_docs_v18/methods/contacts_search.md

55 lines
1.3 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: contacts.search
description: Search contacts
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: contacts.search
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Search contacts
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|q|[string](../types/string.md) | The search query | Yes|
|limit|[int](../types/int.md) | How many results should be returned | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [contacts\_Found](../types/contacts_Found.md)
### Can bots use this method: **NO**
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
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:
```lua
2018-04-01 13:19:25 +02:00
contacts_Found = contacts.search({q='string', limit=int, })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|QUERY_TOO_SHORT|The query string is too short|
|SEARCH_QUERY_EMPTY|The search query is empty|
2019-06-30 15:12:21 +02:00
|Timeout|Timeout while fetching data|
2018-04-01 13:19:25 +02:00