MadelineProto/old_docs/API_docs_v53/methods/contacts_getTopPeers.md

2.2 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
bots_pm CLICK ME Bool Optional
bots_inline CLICK ME Bool Optional
groups CLICK ME Bool Optional
channels CLICK ME Bool Optional
offset CLICK ME int Yes
limit CLICK ME int Yes
hash CLICK ME int Yes

Return type: contacts_TopPeers

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');
}
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();

$contacts_TopPeers = $MadelineProto->contacts->getTopPeers(['correspondents' => Bool, 'bots_pm' => Bool, 'bots_inline' => Bool, 'groups' => Bool, 'channels' => Bool, 'offset' => int, 'limit' => int, 'hash' => int, ]);

Or, if you're using the PWRTelegram HTTP API:

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

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, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, })