# Method: contacts.getTopPeers

Back to methods index

Get most used peers

# Parameters:

Name Type Description Required
correspondents Bool Users we’ve chatted most frequently with Optional
bots_pm Bool Most used bots Optional
bots_inline Bool Most used inline bots Optional
phone_calls Bool Most frequently called users Optional
forward_users Bool Users to which the users often forwards messages to Optional
forward_chats Bool Chats to which the users often forwards messages to Optional
groups Bool Often-opened groups and supergroups Optional
channels Bool Most frequently visited channels Optional
offset int Offset for pagination Yes
limit int Maximum number of results to return, see pagination Yes
hash Array of int Hash for pagination, for more info click here Optional

# Return type: contacts.TopPeers

# Can bots use this method: NO

# MadelineProto Example (now async for huge speed and parallelism!):

if (!file_exists('madeline.php')) {
    copy('https://phar.madelineproto.xyz/madeline.php', '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, 'forward_users' => Bool, 'forward_chats' => Bool, 'groups' => Bool, 'channels' => Bool, 'offset' => int, 'limit' => int, 'hash' => [int, int], ]);

Or, if you’re into Lua:

contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, phone_calls=Bool, forward_users=Bool, forward_chats=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash={int}, })

# Errors

Code Type Description
400 TYPES_EMPTY No top peer type was provided
This site uses cookies, as described in the cookie policy. By clicking on "Accept" you consent to the use of cookies.