MadelineProto/old_docs/API_docs_v71/methods/contacts_search.md

69 lines
1.4 KiB
Markdown
Raw Normal View History

2017-10-14 11:50:46 +02:00
---
title: contacts.search
description: contacts.search parameters, return type and example
---
## Method: contacts.search
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|q|[string](../types/string.md) | Yes|
|limit|[int](../types/int.md) | Yes|
### Return type: [contacts\_Found](../types/contacts_Found.md)
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01:00
### 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|
2017-10-14 11:50:46 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-10-14 11:50:46 +02:00
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
2017-10-14 11:50:46 +02:00
$MadelineProto->complete_phone_login($code);
}
$contacts_Found = $MadelineProto->contacts->search(['q' => 'string', 'limit' => int, ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### 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, })
```