MadelineProto/old_docs/API_docs_v72/methods/contacts_getTopPeers.md

95 lines
2.2 KiB
Markdown
Raw Normal View History

2017-11-15 13:41:58 +01:00
---
title: contacts.getTopPeers
description: Get most used chats
2017-11-15 13:41:58 +01:00
---
## Method: contacts.getTopPeers
[Back to methods index](index.md)
Get most used chats
2017-11-15 13:41:58 +01:00
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|correspondents|[Bool](../types/Bool.md) | Optional||
|bots\_pm|[Bool](../types/Bool.md) | Optional||
|bots\_inline|[Bool](../types/Bool.md) | Optional||
|phone\_calls|[Bool](../types/Bool.md) | Optional||
|groups|[Bool](../types/Bool.md) | Optional||
|channels|[Bool](../types/Bool.md) | Optional||
|offset|[int](../types/int.md) | Yes||
|limit|[int](../types/int.md) | Yes||
|hash|[int](../types/int.md) | Yes||
2017-11-15 13:41:58 +01:00
### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|TYPES_EMPTY|The types field is empty|
### Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2017-11-15 13:41:58 +01:00
}
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-11-15 13:41:58 +01:00
$contacts_TopPeers = $MadelineProto->contacts->getTopPeers(['correspondents' => Bool, 'bots_pm' => Bool, 'bots_inline' => Bool, 'phone_calls' => Bool, 'groups' => Bool, 'channels' => Bool, 'offset' => int, 'limit' => int, 'hash' => 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.getTopPeers`
Parameters:
correspondents - Json encoded Bool
bots_pm - Json encoded Bool
bots_inline - Json encoded Bool
phone_calls - Json encoded Bool
groups - Json encoded Bool
channels - Json encoded Bool
offset - Json encoded int
limit - Json encoded int
hash - Json encoded int
Or, if you're into Lua:
```
contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, phone_calls=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, })
```