channels.getParticipants

Get the participants of a supergroup/channel

Example

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

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result = await client.invoke(new Api.channels.getParticipants({
        channel: new Api.InputChannel({...}),
        filter: new Api.ChannelParticipantsFilter({...}),
        offset: 8575241,
        limit: 8740833,
        hash: 2176980,
        }));
    console.log(result); // prints the result
})();

TL schema

channels.channelParticipants#f56ee2a8 count:int participants:Vector<ChannelParticipant> users:Vector<User> = channels.ChannelParticipants;
channels.channelParticipantsNotModified#f0173fe9 = channels.ChannelParticipants;
---functions---
channels.getParticipants#123e05e9 channel:InputChannel filter:ChannelParticipantsFilter offset:int limit:int hash:int = channels.ChannelParticipants;

Parameters

Name

Type

Description

channel

Channel

filter

Which participant types to fetch

offset

limit

hash

Result

channels.ChannelParticipants

Possible errors

Code

Type

Description

400

CHANNEL_INVALID

The provided channel is invalid

400

CHANNEL_PRIVATE

You haven't joined this channel/supergroup

400

CHAT_ADMIN_REQUIRED

You must be an admin in this chat to do this

400

INPUT_CONSTRUCTOR_INVALID

The provided constructor is invalid

Can bots use this methd ?

yes

How to fetch results from large lists of objects.

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

Last updated