MadelineProto/docs/TD_docs/methods/searchContacts.md

77 lines
1.7 KiB
Markdown
Raw Normal View History

---
title: searchContacts
description: Searches for specified query in the first name, last name and username of the known user contacts
---
## Method: searchContacts
[Back to methods index](index.md)
2017-06-06 18:39:21 +02:00
YOU CANNOT USE THIS METHOD IN MADELINEPROTO
Searches for specified query in the first name, last name and username of the known user contacts
### Params:
| Name | Type | Required | Description |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|-------------|
|query|[string](../types/string.md) | Yes|Query to search for, can be empty to return all contacts|
|limit|[int](../types/int.md) | Yes|Maximum number of users to be returned|
### Return type: [Users](../types/Users.md)
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
2017-07-23 16:33:46 +02:00
$Users = $MadelineProto->searchContacts(['query' => 'string', 'limit' => int, ]);
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 16:11:02 +02:00
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - searchContacts
2017-07-23 16:40:54 +02:00
* params - `{"query": "string", "limit": int, }`
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/searchContacts`
Parameters:
query - 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
Users = searchContacts({query='string', limit=int, })
```