Skip to content

getChannelMembers

Sahri Riza Umami edited this page Dec 8, 2016 · 5 revisions

Returns information about channel members or kicked from channel users.

getChannelMembers(channel_id, offset, filter, limit)

Can be used only if channel_full -> can_get_members == true.

Option Description
channel_id Identifier of the channel.
filter Kind of channel users to return, defaults to channelMembersRecent. The filters are Recent, Administrators, Kicked, and Bots.
offset Number of channel users to skip.
limit Maximum number of users be returned, can't be greater than 200.

Example

  • Return recently active users in reverse chronological order.
getChannelMembers(1234567890, 0, 'Recent', 20)
  • Return privileged members, i.e. creator, editors and moderators are returned.
getChannelMembers(1234567890, 0, 'Administrators', 20)
  • Return kicked from the channel.
getChannelMembers(1234567890, 0, 'Kicked', 20)
  • Return bots in the channel.
getChannelMembers(1234567890, 0, 'Bots', 20)

Test script
Frequently Asked Questions
The Functions

Clone this wiki locally