Method: contacts.getTopPeers

Back to methods index

Get most used chats


Name Type Description Required
correspondents Bool Fetch users? Optional
bots_pm Bool Fetch bots? Optional
bots_inline Bool Fetch inline bots? Optional
phone_calls Bool Fetch phone calls? Optional
groups Bool Fetch groups? Optional
channels Bool Fetch channels and supergroups? Optional
offset int Initially 0, then $offset += $contacts_TopPeers['categories']['count']; Yes
limit int How many results to fetch Yes
hash Array of int Peer IDs of previously cached peers Optional

Return type: contacts_TopPeers

Can bots use this method: NO

MadelineProto Example:

if (!file_exists('madeline.php')) {
    copy('', 'madeline.php');
include 'madeline.php';

$MadelineProto = new \danog\MadelineProto\API('session.madeline');

$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, int], ]);

PWRTelegram HTTP API example (NOT FOR MadelineProto):

As a user:



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 array of 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