88 lines
2.1 KiB
Markdown
88 lines
2.1 KiB
Markdown
|
---
|
||
|
|
title: contacts.getTopPeers
|
||
|
|
description: contacts.getTopPeers parameters, return type and example
|
||
|
|
---
|
||
|
|
## Method: contacts.getTopPeers
|
||
|
|
[Back to methods index](index.md)
|
||
|
|
|
||
|
|
|
||
|
|
### Parameters:
|
||
|
|
|
||
|
|
| Name | Type | Required |
|
||
|
|
|----------|---------------|----------|
|
||
|
|
|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|
|
||
|
|
|
||
|
|
|
||
|
|
### 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:
|
||
|
|
|
||
|
|
|
||
|
|
```
|
||
|
|
$MadelineProto = new \danog\MadelineProto\API();
|
||
|
|
$MadelineProto->session = 'mySession.madeline';
|
||
|
|
if (isset($number)) { // Login as a user
|
||
|
|
$MadelineProto->phone_login($number);
|
||
|
|
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
|
||
|
|
$MadelineProto->complete_phone_login($code);
|
||
|
|
}
|
||
|
|
|
||
|
|
$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, })
|
||
|
|
```
|
||
|
|
|