# Pyrogram - Telegram MTProto API Client Library for Python # Copyright (C) 2017-2018 Dan Tès # # This file is part of Pyrogram. # # Pyrogram is free software: you can redistribute it and/or modify # it under the terms of the GNU Lesser General Public License as published # by the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # Pyrogram is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public License # along with Pyrogram. If not, see . from pyrogram.api import functions, types from ...ext import BaseClient, utils class Filters: ALL = "all" KICKED = "kicked" RESTRICTED = "restricted" BOTS = "bots" RECENT = "recent" ADMINISTRATORS = "administrators" class GetChatMembers(BaseClient): async def get_chat_members(self, chat_id: int or str, offset: int = 0, limit: int = 200, query: str = "", filter: str = Filters.ALL): """Use this method to get the members list of a chat. A chat can be either a basic group, a supergroup or a channel. You must be admin to retrieve the members list of a channel (also known as "subscribers"). Args: chat_id (``int`` | ``str``): Unique identifier (int) or username (str) of the target chat. offset (``int``, *optional*): Sequential number of the first member to be returned. Defaults to 0 [1]_. limit (``int``, *optional*): Limits the number of members to be retrieved. Defaults to 200, which is also the maximum server limit allowed per method call. query (``str``, *optional*): Query string to filter members based on their display names and usernames. Defaults to "" (empty string) [2]_. filter (``str``, *optional*): Filter used to select the kind of members you want to retrieve. Only applicable for supergroups and channels. It can be any of the followings: *"all"* - all kind of members, *"kicked"* - kicked (banned) members only, *"restricted"* - restricted members only, *"bots"* - bots only, *"recent"* - recent members only, *"administrators"* - chat administrators only. Defaults to *"all"*. .. [1] Server limit: on supergroups, you can get up to 10,000 members for a single query and up to 200 members on channels. .. [2] A query string is applicable only for *"all"*, *"kicked"* and *"restricted"* filters only. Returns: On success, a :obj:`ChatMembers` object is returned. Raises: :class:`Error ` in case of a Telegram RPC error. ``ValueError`` if you used an invalid filter or a chat_id that belongs to a user. """ peer = await self.resolve_peer(chat_id) if isinstance(peer, types.InputPeerChat): return utils.parse_chat_members( await self.send( functions.messages.GetFullChat( peer.chat_id ) ) ) elif isinstance(peer, types.InputPeerChannel): filter = filter.lower() if filter == Filters.ALL: filter = types.ChannelParticipantsSearch(q=query) elif filter == Filters.KICKED: filter = types.ChannelParticipantsKicked(q=query) elif filter == Filters.RESTRICTED: filter = types.ChannelParticipantsBanned(q=query) elif filter == Filters.BOTS: filter = types.ChannelParticipantsBots() elif filter == Filters.RECENT: filter = types.ChannelParticipantsRecent() elif filter == Filters.ADMINISTRATORS: filter = types.ChannelParticipantsAdmins() else: raise ValueError("Invalid filter \"{}\"".format(filter)) return utils.parse_chat_members( await self.send( functions.channels.GetParticipants( channel=peer, filter=filter, offset=offset, limit=limit, hash=0 ) ) ) else: raise ValueError("The chat_id \"{}\" belongs to a user".format(chat_id))