MadelineProto/old_docs/API_docs_v46/methods/channels_getParticipants.md

91 lines
2.4 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: channels.getParticipants
description: channels.getParticipants parameters, return type and example
---
2017-01-19 23:02:27 +01:00
## Method: channels.getParticipants
[Back to methods index](index.md)
2018-03-14 12:08:10 +01:00
### Parameters:
2018-03-14 12:08:10 +01:00
| Name | Type | Required |
|----------|---------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|
2018-03-20 16:42:05 +01:00
|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|
|offset|[CLICK ME int](../types/int.md) | Yes|
|limit|[CLICK ME int](../types/int.md) | Yes|
2018-03-14 12:08:10 +01:00
### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md)
### Can bots use this method: **YES**
### 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|
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
2018-03-14 12:08:10 +01:00
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2018-03-14 12:08:10 +01:00
}
include 'madeline.php';
// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();
2018-03-14 12:08:10 +01:00
$channels_ChannelParticipants = $MadelineProto->channels->getParticipants(['channel' => InputChannel, 'filter' => ChannelParticipantsFilter, 'offset' => int, 'limit' => int, ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2018-03-14 12:08:10 +01:00
### 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, }`
### 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
Or, if you're into Lua:
```
channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, })
```