MadelineProto/docs/TD_docs/methods/getChannelMembers.md

50 lines
1.6 KiB
Markdown
Raw Normal View History

---
title: getChannelMembers
description: Returns information about channel members or kicked from channel users. Can be used only if channel_full->can_get_members == true
---
## Method: getChannelMembers
[Back to methods index](index.md)
Returns information about channel members or kicked from channel users. Can be used only if channel_full->can_get_members == true
### Params:
| Name | Type | Required | Description |
|----------|:-------------:|:--------:|------------:|
|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel|
|filter|[ChannelMembersFilter](../types/ChannelMembersFilter.md) | Yes|Kind of channel users to return, defaults to channelMembersRecent|
|offset|[int](../types/int.md) | Yes|Number of channel users to skip|
|limit|[int](../types/int.md) | Yes|Maximum number of users be returned, can't be greater than 200|
### Return type: [ChatMembers](../types/ChatMembers.md)
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($token)) {
$this->bot_login($token);
}
if (isset($number)) {
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
$ChatMembers = $MadelineProto->getChannelMembers(['channel_id' => int, 'filter' => ChannelMembersFilter, 'offset' => int, 'limit' => int, ]);
```
Or, if you're into Lua:
```
ChatMembers = getChannelMembers({channel_id=int, filter=ChannelMembersFilter, offset=int, limit=int, })
```