MadelineProtoDocs/old_docs/API_docs_v89/methods/contacts_search.md

72 lines
1.5 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2018-12-26 02:56:50 +01: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-12-26 02:56:50 +01:00
# Method: contacts.search
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2018-12-26 02:56:50 +01:00
Search contacts
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2018-12-26 02:56:50 +01:00
|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
2018-12-26 02:56:50 +01:00
### Return type: [contacts\_Found](../types/contacts_Found.md)
2018-04-01 13:19:25 +02:00
### Can bots use this method: **NO**
### MadelineProto Example:
```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();
2018-12-26 02:56:50 +01:00
$contacts_Found = $MadelineProto->contacts->search(['q' => 'string', 'limit' => int, ]);
2018-04-01 13:19:25 +02:00
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
2018-12-26 02:56:50 +01:00
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.search`
2018-04-01 13:19:25 +02:00
Parameters:
2018-12-26 02:56:50 +01:00
q - Json encoded string
limit - Json encoded int
2018-04-01 13:19:25 +02:00
Or, if you're into Lua:
```lua
2018-12-26 02:56:50 +01:00
contacts_Found = contacts.search({q='string', limit=int, })
2018-04-01 13:19:25 +02:00
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
2018-12-26 02:56:50 +01:00
|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|
2018-04-01 13:19:25 +02:00