GetParticipantsRequest

Both users and bots can use this request. See code examples.

---functions---
channels.getParticipants#77ced9d0 channel:InputChannel filter:ChannelParticipantsFilter offset:int limit:int hash:long = channels.ChannelParticipants

Returns

channels.ChannelParticipants

This type can be an instance of either:

ChannelParticipants

ChannelParticipantsNotModified

Parameters

channel	InputChannel	Anything entity-like will work if the library can find its `Input` version (e.g., usernames, `Peer`, `User` or `Channel` objects, etc.).
filter	ChannelParticipantsFilter
offset	int
limit	int
hash	long

Known RPC errors

This request can cause 5 known errors:

`ChannelInvalidError`	Invalid channel object. Make sure to pass the right types, for instance making sure that the request is designed for channels or otherwise look for a different one more suited.
`ChannelPrivateError`	The channel specified is private and you lack permission to access it. Another reason may be that you were banned from it.
`ChatAdminRequiredError`	Chat admin privileges are required to do that in the specified chat (for example, to send a message in a channel which is not yours), or invalid permissions used for the channel or group.
`InputConstructorInvalidError`	The provided constructor is invalid.
`TimeoutError`	A timeout occurred while fetching data from the worker.

You can import these from telethon.errors.

Example

Please refer to the documentation of client.iter_participants() to learn about the parameters and see several code examples on how to use it.

The method above is the recommended way to do it. If you need more control over the parameters or want to learn how it is implemented, open the details by clicking on the "Details" text.

from telethon.sync import TelegramClient
from telethon import functions, types

with TelegramClient(name, api_id, api_hash) as client:
    result = client(functions.channels.GetParticipantsRequest(
        channel='username',
        filter=types.ChannelParticipantsRecent(),
        offset=42,
        limit=100,
        hash=-12398745604826
    ))
    print(result.stringify())