mirror of
https://github.com/danog/MadelineProto.git
synced 2024-12-12 16:47:24 +01:00
2.3 KiB
2.3 KiB
title | description |
---|---|
contacts.getTopPeers | Get most used chats |
Method: contacts.getTopPeers
Get most used chats
Parameters:
Name | Type | Required | Description |
---|---|---|---|
correspondents | Bool | Optional | Fetch users? |
bots_pm | Bool | Optional | Fetch bots? |
bots_inline | Bool | Optional | Fetch inline bots? |
phone_calls | Bool | Optional | Fetch phone calls? |
groups | Bool | Optional | Fetch groups? |
channels | Bool | Optional | Fetch channels and supergroups? |
offset | int | Yes | Initially 0, then $offset += $contacts_TopPeers['categories']['count']; |
limit | int | Yes | How many results to fetch |
hash | int | Yes | $MadelineProto->gen_vector_hash(previously fetched peer ids); |
Return type: contacts_TopPeers
Can bots use this method: NO
MadelineProto Example:
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();
$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, ]);
PWRTelegram HTTP API example (NOT FOR MadelineProto):
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, })
Errors this method can return:
Error | Description |
---|---|
TYPES_EMPTY | The types field is empty |