contacts.getTopPeers

Get most used peers

API section: Working with contacts and top peers

contacts.getTopPeers#973478b6 flags:# correspondents:flags.0?true bots_pm:flags.1?true bots_inline:flags.2?true phone_calls:flags.3?true forward_users:flags.4?true forward_chats:flags.5?true groups:flags.10?true channels:flags.15?true bots_app:flags.16?true offset:int limit:int hash:long = contacts.TopPeers;

Parameters

NameTypeDescription
flags # Bit mask: a field written flags.N?T is present only when bit N is set.
correspondents flags.0?true
bots_pm flags.1?true
bots_inline flags.2?true
phone_calls flags.3?true
forward_users flags.4?true
forward_chats flags.5?true
groups flags.10?true
channels flags.15?true
bots_app flags.16?true
offset int How many records to skip from the start of the selection.
limit int Maximum number of records to return.
hash long Hash of what the client already has. If it matches, the server answers "not modified" and sends nothing again.

Result

contacts.TopPeers

Possible errors

This method has no errors of its own: it either answers or fails on the shared checks below.

Common to every call

CodeTypeWhat it means
401 AUTH_KEY_UNREGISTERED The server does not know this session: the key was revoked, expired, or the call was made before authorisation.
401 API_ID_INVALID This api_id was never issued or has been blocked. Keys come from my.ansible.su.
400 CONNECTION_LAYER_INVALID The client did not declare a layer, or declared one the server does not know.
420 FLOOD_WAIT_X Too often. Do not retry for X seconds — the number arrives in the error text.
500 INTERNAL A failure on our side. The request may be retried; if it keeps failing, it is a bug of ours.

Related pages

Types used here