MadelineProtoDocs/docs/API_docs/methods/channels_getParticipants.md
Sean 4baac3178e Add Syntax Highlight for Markdown
Add PHP, Lua language tag to Code area
2018-10-18 00:30:20 +08:00

2.7 KiB

title description image
channels.getParticipants Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Method: channels.getParticipants

Back to methods index

Get channel/supergroup participants (you should use $MadelineProto->get_pwr_chat($id) instead)

Parameters:

Name Type Description Required
channel Username, chat ID, Update, Message or InputChannel The channel Optional
filter ChannelParticipantsFilter Member filter 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:

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], ]);

PWRTelegram HTTP API example (NOT FOR MadelineProto):

As a bot:

POST/GET to https://api.pwrtelegram.xyz/botTOKEN/madeline

Parameters:

  • method - channels.getParticipants
  • params - {"channel": InputChannel, "filter": ChannelParticipantsFilter, "offset": int, "limit": int, "hash": [int], }

As a user:

POST/GET to https://api.pwrtelegram.xyz/userTOKEN/channels.getParticipants

Parameters:

channel - Json encoded InputChannel

filter - Json encoded ChannelParticipantsFilter

offset - Json encoded int

limit - Json encoded int

hash - Json encoded array of int

Or, if you're into Lua:

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

Errors this method can return:

Error Description
CHANNEL_INVALID The provided channel is invalid
CHANNEL_PRIVATE You haven't joined this channel/supergroup
CHAT_ADMIN_REQUIRED You must be an admin in this chat to do this
INPUT_CONSTRUCTOR_INVALID The provided constructor is invalid
Timeout A timeout occurred while fetching data from the bot