MadelineProtoDocs/old_docs/API_docs_v28/methods/contacts.search.md

57 lines
1.4 KiB
Markdown
Raw Normal View History

2019-06-23 13:07:51 +02:00
---
2020-06-16 17:50:25 +02:00
title: contacts.search
description: Returns users found by username substring.
2019-06-23 13:07:51 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2020-06-16 17:50:25 +02:00
redirect_from: /API_docs/methods/contacts_search.html
2019-06-23 13:07:51 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: contacts.search
2019-06-23 13:07:51 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
Returns users found by username substring.
2019-06-23 13:07:51 +02:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2020-06-16 17:50:25 +02:00
|q|[string](../types/string.md) | Target substring | Yes|
|limit|[int](../types/int.md) | Maximum number of users to be returned | Yes|
2019-06-23 13:07:51 +02:00
2020-06-16 17:50:25 +02:00
### Return type: [contacts.Found](../types/contacts.Found.md)
2019-06-23 13:07:51 +02:00
2020-06-16 17:50:25 +02:00
### Can bots use this method: **NO**
2019-06-23 13:07:51 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
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();
2020-06-16 17:50:25 +02:00
$contacts.Found = $MadelineProto->contacts->search(['q' => 'string', 'limit' => int, ]);
2019-06-23 13:07:51 +02:00
```
Or, if you're into Lua:
```lua
2020-06-16 17:50:25 +02:00
contacts.Found = contacts.search({q='string', limit=int, })
2019-06-23 13:07:51 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
2019-06-23 13:07:51 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
2020-06-16 17:50:25 +02:00
|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|
2019-06-23 13:07:51 +02:00