Skip to content

getSupergroupMembers

Sahri Riza Umami edited this page Jun 24, 2018 · 1 revision

Returns information about members or banned users in a supergroup or channel.
Can be used only if SupergroupFullInfo.can_get_members == true; additionally, administrator privileges may be required for some filters.

getSupergroupMembers(supergroup_id, filter, query, offset, limit, callback, data)
Field Type Description
supergroup_id int32 Identifier of the supergroup or channel.
filter The type of users to return: Recent, Administrators, Search, resctricted, Banned or Bots. By default, supergroupMembersRecent.
query string Query to search for.
offset int32 Number of users to skip.
limit int32 The maximum number of users be returned; up to 200.

Example

  • Get information about members in supergroup 1234567890.

    getSupergroupMembers(1234567890)

    Response:

    {
      ["@type"] = "chatMembers",
      members = {
        {
          ["@type"] = "chatMember",
          inviter_user_id = 99999999,
          joined_chat_date = 1522061460,
          status = {
            ["@type"] = "chatMemberStatusAdministrator",
            can_be_edited = false,
            can_change_info = true,
            can_delete_messages = true,
            can_edit_messages = true,
            can_invite_users = true,
            can_pin_messages = true,
            can_post_messages = true,
            can_promote_members = true,
            can_restrict_members = true
          },
          user_id = 11111111
        },
        {
          ["@type"] = "chatMember",
          inviter_user_id = 99999999,
          joined_chat_date = 1488803919,
          status = {
            ["@type"] = "chatMemberStatusAdministrator",
            can_be_edited = false,
            can_change_info = true,
            can_delete_messages = true,
            can_edit_messages = false,
            can_invite_users = true,
            can_pin_messages = true,
            can_post_messages = false,
            can_promote_members = true,
            can_restrict_members = true
          },
          user_id = 22222222
        },
        {
          ["@type"] = "chatMember",
          inviter_user_id = 0,
          joined_chat_date = 0,
          status = {
            ["@type"] = "chatMemberStatusCreator",
            is_member = true
          },
          user_id = 99999999
        },
        {
          ["@type"] = "chatMember",
          bot_info = {
            ["@type"] = "botInfo",
            commands = {},
            description = ""
          },
          inviter_user_id = 99999999,
          joined_chat_date = 1521287680,
          status = {
            ["@type"] = "chatMemberStatusAdministrator",
            can_be_edited = false,
            can_change_info = true,
            can_delete_messages = true,
            can_edit_messages = false,
            can_invite_users = true,
            can_pin_messages = true,
            can_post_messages = false,
            can_promote_members = false,
            can_restrict_members = true
          },
          user_id = 33333333
        },
        {
          ["@type"] = "chatMember",
          bot_info = {
            ["@type"] = "botInfo",
            commands = {},
            description = ""
          },
          inviter_user_id = 0,
          joined_chat_date = 1517131680,
          status = {
            ["@type"] = "chatMemberStatusMember"
          },
          user_id = 44444444
        },
        {
          ["@type"] = "chatMember",
          bot_info = {
            ["@type"] = "botInfo",
            commands = {},
            description = ""
          },
          inviter_user_id = 0,
          joined_chat_date = 1517131455,
          status = {
            ["@type"] = "chatMemberStatusMember"
          },
          user_id = 55555555
        },
        {
          ["@type"] = "chatMember",
          bot_info = {
            ["@type"] = "botInfo",
            commands = {},
            description = ""
          },
          inviter_user_id = 0,
          joined_chat_date = 1504522376,
          status = {
            ["@type"] = "chatMemberStatusMember"
          },
          user_id = 66666666
        }
      },
      total_count = 7
    }

Frequently Asked Questions
The Functions

Clone this wiki locally