GramJS

contacts.GetTopPeers

Get most used peers

Example

const { Api, TelegramClient } = require("telegram");
const { StringSession } = require("telegram/sessions");

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result = await client.invoke(
    new Api.contacts.GetTopPeers({
      offset: 43,
      limit: 100,
      hash: 0,
      correspondents: true,
      botsPm: true,
      botsInline: true,
      phoneCalls: true,
      forwardUsers: true,
      forwardChats: true,
      groups: true,
      channels: true,
    })
  );
  console.log(result); // prints the result
})();
import { Api, TelegramClient } from "telegram";
import { StringSession } from "telegram/sessions";

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result: Api.contacts.TopPeers = await client.invoke(
    new Api.contacts.GetTopPeers({
      offset: 43,
      limit: 100,
      hash: 0,
      correspondents: true,
      botsPm: true,
      botsInline: true,
      phoneCalls: true,
      forwardUsers: true,
      forwardChats: true,
      groups: true,
      channels: true,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
flags#Flags, see TL conditional fields
correspondentsflags.0?trueUsers we've chatted most frequently with
botsPmflags.1?trueMost used bots
botsInlineflags.2?trueMost used inline bots
phoneCallsflags.3?trueMost frequently called users
forwardUsersflags.4?trueUsers to which the users often forwards messages to
forwardChatsflags.5?trueChats to which the users often forwards messages to
groupsflags.10?trueOften-opened groups and supergroups
channelsflags.15?trueMost frequently visited channels
offsetintOffset for pagination
limitintMaximum number of results to return, see pagination
hashintHash for pagination, for more info click here

Result

contacts.TopPeers

Possible errors

CodeTypeDescription
400TYPES_EMPTYNo top peer type was provided

Can bots use this method?

No

Pagination in the API

How to fetch results from large lists of objects.