MadelineProtoDocs/old_docs/API_docs_v102/methods/contacts.getTopPeers.md

63 lines
2.5 KiB
Markdown
Raw Normal View History

2019-06-23 13:07:51 +02:00
---
title: contacts.getTopPeers
2019-12-27 17:48:04 +01:00
description: Get most used peers
2019-06-23 13:07:51 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/contacts_getTopPeers.html
2019-06-23 13:07:51 +02:00
---
# Method: contacts.getTopPeers
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Get most used peers
2019-06-23 13:07:51 +02:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|correspondents|[Bool](../types/Bool.md) | Users we've chatted most frequently with | Optional|
|bots\_pm|[Bool](../types/Bool.md) | Most used bots | Optional|
|bots\_inline|[Bool](../types/Bool.md) | Most used inline bots | Optional|
|phone\_calls|[Bool](../types/Bool.md) | Most frequently called users | Optional|
|forward\_users|[Bool](../types/Bool.md) | Users to which the users often forwards messages to | Optional|
|forward\_chats|[Bool](../types/Bool.md) | Chats to which the users often forwards messages to | Optional|
|groups|[Bool](../types/Bool.md) | Often-opened groups and supergroups | Optional|
|channels|[Bool](../types/Bool.md) | Most frequently visited channels | Optional|
|offset|[int](../types/int.md) | Offset for [pagination](https://core.telegram.org/api/offsets) | Yes|
|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes|
2019-06-23 13:07:51 +02:00
|hash|Array of [int](../types/int.md) | Peer IDs of previously cached peers | Optional|
2019-12-27 18:25:37 +01:00
### Return type: [contacts.TopPeers](../types/contacts.TopPeers.md)
2019-06-23 13:07:51 +02:00
### Can bots use this method: **NO**
### 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();
2019-12-27 18:25:37 +01:00
$contacts.TopPeers = $MadelineProto->contacts->getTopPeers(['correspondents' => Bool, 'bots_pm' => Bool, 'bots_inline' => Bool, 'phone_calls' => Bool, 'forward_users' => Bool, 'forward_chats' => Bool, 'groups' => Bool, 'channels' => Bool, 'offset' => int, 'limit' => int, 'hash' => [int, int], ]);
2019-06-23 13:07:51 +02:00
```
Or, if you're into Lua:
```lua
2019-12-27 18:25:37 +01:00
contacts.TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, phone_calls=Bool, forward_users=Bool, forward_chats=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash={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 |
|------|----------|---------------|
|400|TYPES_EMPTY|No top peer type was provided|
2019-06-23 13:07:51 +02:00