61 lines
2.2 KiB
Markdown
61 lines
2.2 KiB
Markdown
---
|
|
title: channels.getParticipants
|
|
description: Get the participants of a channel
|
|
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|
---
|
|
# Method: channels.getParticipants
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
Get the participants of a channel
|
|
|
|
### Parameters:
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|---------------|-------------|----------|
|
|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional|
|
|
|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Which participant types to fetch | Yes|
|
|
|offset|[int](../types/int.md) | [Offset](https://core.telegram.org/api/offsets) | Yes|
|
|
|limit|[int](../types/int.md) | [Limit](https://core.telegram.org/api/offsets) | Yes|
|
|
|hash|Array of [int](../types/int.md) | IDs of previously fetched participants | Optional|
|
|
|
|
|
|
### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md)
|
|
|
|
### Can bots use this method: **YES**
|
|
|
|
|
|
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
|
|
|
|
|
|
```php
|
|
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:
|
|
|
|
```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|
|
|
|
|
|