MadelineProtoDocs/old_docs/API_docs_v97/methods/channels.getParticipants.md
2019-12-27 18:46:25 +01:00

2.2 KiB

title description image redirect_from
channels.getParticipants Get the participants of a channel https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png /API_docs/methods/channels_getParticipants.html

Method: channels.getParticipants

Back to methods index

Get the participants of a channel

Parameters:

Name Type Description Required
channel Username, chat ID, Update, Message or InputChannel Channel Optional
filter ChannelParticipantsFilter Which participant types to fetch Yes
offset int Offset Yes
limit int Limit Yes
hash Array of int IDs of previously fetched participants Optional

Return type: channels.ChannelParticipants

Can bots use this method: YES

MadelineProto Example (now async for huge speed and parallelism!):

if (!file_exists('madeline.php')) {
    copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';

$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();

$channels.ChannelParticipants = $MadelineProto->channels->getParticipants(['channel' => InputChannel, 'filter' => ChannelParticipantsFilter, 'offset' => int, 'limit' => int, 'hash' => [int, int], ]);

Or, if you're into Lua:

channels.ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, hash={int}, })

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
406 AUTH_KEY_DUPLICATED An auth key with the same ID was already generated
-503 Timeout Timeout while fetching data