1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-14 06:07:20 +01:00
MadelineProto/docs/API_docs/methods/contacts_search.md

76 lines
1.6 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
title: contacts.search
description: Search contacts
2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
## Method: contacts.search
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
Search contacts
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-03-20 16:42:05 +01:00
|q|[CLICK ME string](../types/string.md) | Yes|The search query|
|limit|[CLICK ME int](../types/int.md) | Yes|How many results should be returned|
2016-12-19 18:35:27 +01:00
### Return type: [contacts\_Found](../types/contacts_Found.md)
2017-08-28 12:44:50 +02:00
### 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|
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();
2017-07-23 16:33:46 +02:00
$contacts_Found = $MadelineProto->contacts->search(['q' => 'string', 'limit' => int, ]);
2017-02-13 04:33:06 +01:00
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.search`
Parameters:
q - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
limit - Json encoded int
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
contacts_Found = contacts.search({q='string', limit=int, })
```