1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-11 08:19:38 +01:00
MadelineProto/old_docs/API_docs_v68/methods/contacts_getTopPeers.md

2.4 KiB

title description
contacts.getTopPeers Get most used chats

Method: contacts.getTopPeers

Back to methods index

Get most used chats

Parameters:

Name Type Required Description
correspondents CLICK ME Bool Optional Fetch users?
bots_pm CLICK ME Bool Optional Fetch bots?
bots_inline CLICK ME Bool Optional Fetch inline bots?
phone_calls CLICK ME Bool Optional Fetch phone calls?
groups CLICK ME Bool Optional Fetch groups?
channels CLICK ME Bool Optional Fetch channels and supergroups?
offset CLICK ME int Yes Initially 0, then $offset += $contacts_TopPeers['categories']['count'];
limit CLICK ME int Yes How many results to fetch
hash CLICK ME int Yes $MadelineProto->gen_vector_hash(previously fetched peer ids);

Return type: contacts_TopPeers

Can bots use this method: NO

Errors this method can return:

Error Description
TYPES_EMPTY The types field is empty

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, })