GramJS

channels.GetParticipants

Get the participants of a supergroup/channel

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.channels.GetParticipants({
      channel: "username",
      filter: new Api.ChannelParticipantsRecent({}),
      offset: 43,
      limit: 100,
      hash: 0,
    })
  );
  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.channels.ChannelParticipants = await client.invoke(
    new Api.channels.GetParticipants({
      channel: "username",
      filter: new Api.ChannelParticipantsRecent({}),
      offset: 43,
      limit: 100,
      hash: 0,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
channelInputChannelChannel
filterChannelParticipantsFilterWhich participant types to fetch
offsetintOffset
limitintLimit
hashintHash

Result

channels.ChannelParticipants

Possible errors

CodeTypeDescription
400CHANNEL_INVALIDThe provided channel is invalid
400CHANNEL_PRIVATEYou haven't joined this channel/supergroup
400CHAT_ADMIN_REQUIREDYou must be an admin in this chat to do this
400INPUT_CONSTRUCTOR_INVALIDThe provided constructor is invalid

Can bots use this method?

Yes

Pagination in the API

How to fetch results from large lists of objects.

Channels

How to handle channels, supergroups, groups, and what's the difference between them.