Skip to content

getChannelMembers

Sahri Riza Umami edited this page Jun 17, 2017 · 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, 'Recent', 0, 20)

    Response:

    {
      ID = "ChatMembers",
      members_ = {
        -- Members table. REDACTED. --
      },
      total_count_ = 8
    }
  • Return privileged members, i.e. creator, editors and moderators are returned.

    getChannelMembers(1234567890, 'Administrators', 0, 20)
    {
      ID = "ChatMembers",
      members_ = {
        [0] = {
          ID = "ChatMember",
          bot_info_ = false,
          inviter_user_id_ = 0,
          join_date_ = 0,
          status_ = {
            ID = "ChatMemberStatusCreator"
          },
          user_id_ = 194211431
        }
      },
      total_count_ = 1
    }
  • Return kicked from the channel.

    getChannelMembers(1234567890, 'Kicked', 0, 20)

    Response:

    {
      ID = "ChatMembers",
      members_ = {
        [0] = {
          ID = "ChatMember",
          bot_info_ = {
            ID = "BotInfo",
            commands_ = {},
            description_ = false
          },
          inviter_user_id_ = 194211431,
          join_date_ = 1497691707,
          status_ = {
            ID = "ChatMemberStatusKicked"
          },
          user_id_ = 71641016
        }
      },
      total_count_ = 1
    }
  • Return bots in the channel.

    getChannelMembers(1234567890, 'Bots', 0, 20)

    Response:

    {
      ID = "ChatMembers",
      members_ = {
        {
          ID = "ChatMember",
          bot_info_ = {
            ID = "BotInfo",
            commands_ = {
              [0] = {
                ID = "BotCommand",
                command_ = "help",
                description_ = "View the help message (in private)"
              }
            },
            description_ = "Saya adalah bot Telegram sederhana yang serbaguna. Selain memiliki banyak plugins untuk membantu menghidupkan percakapan dalam grup, jika dijadikan sebagai administrator supergroup, saya bisa membantu menjaganya."
          },
          inviter_user_id_ = 0,
          join_date_ = 1497122819,
          status_ = {
            ID = "ChatMemberStatusMember"
          },
          user_id_ = 345829823
        },
        [0] = {
          ID = "ChatMember",
          bot_info_ = {
            ID = "BotInfo",
            commands_ = {},
            description_ = false
          },
          inviter_user_id_ = 0,
          join_date_ = 1497691783,
          status_ = {
            ID = "ChatMemberStatusMember"
          },
          user_id_ = 71641016
        }
      },
      total_count_ = 2
    }

Test script
Frequently Asked Questions
The Functions

Clone this wiki locally