MadelineProtoDocs/old_docs/API_docs_v95/methods/channels.getParticipants.md

62 lines
2.2 KiB
Markdown
Raw Normal View History

2019-06-23 13:07:51 +02:00
---
title: channels.getParticipants
2019-12-27 17:48:04 +01:00
description: Get the participants of a channel
2019-06-23 13:07:51 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/channels_getParticipants.html
2019-06-23 13:07:51 +02:00
---
# Method: channels.getParticipants
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Get the participants of a channel
2019-06-23 13:07:51 +02:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|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|
2019-06-23 13:07:51 +02:00
|hash|Array of [int](../types/int.md) | IDs of previously fetched participants | Optional|
2019-12-27 18:25:37 +01:00
### Return type: [channels.ChannelParticipants](../types/channels.ChannelParticipants.md)
2019-06-23 13:07:51 +02:00
### 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();
2019-12-27 18:25:37 +01:00
$channels.ChannelParticipants = $MadelineProto->channels->getParticipants(['channel' => InputChannel, 'filter' => ChannelParticipantsFilter, 'offset' => int, 'limit' => int, 'hash' => [int, int], ]);
2019-06-23 13:07:51 +02:00
```
Or, if you're into Lua:
```lua
2019-12-27 18:25:37 +01:00
channels.ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, hash={int}, })
2019-06-23 13:07:51 +02:00
```
2019-09-02 17:41:28 +02:00
### 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|
2019-12-27 17:48:04 +01:00
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
2019-09-02 17:41:28 +02:00
|-503|Timeout|Timeout while fetching data|
2019-06-23 13:07:51 +02:00