Function getChatMembers

  • getChatMembers(
        client: ITelegramClient,
        chatId: InputPeerLike,
        params?: {
            limit?: number;
            offset?: number;
            query?: string;
            type?:
                | "restricted"
                | "contacts"
                | "bots"
                | "banned"
                | "admins"
                | "mention"
                | "all"
                | "recent";
        },
    ): Promise<ArrayWithTotal<ChatMember>>

  • Get a chunk of members of some chat.

    You can retrieve up to 200 members at once

    Parameters

    • client: ITelegramClient
    • chatId: InputPeerLike

      Chat ID or username

    • Optionalparams: {
          limit?: number;
          offset?: number;
          query?: string;
          type?:
              | "restricted"
              | "contacts"
              | "bots"
              | "banned"
              | "admins"
              | "mention"
              | "all"
              | "recent";
      }

      Additional parameters

      • Optionallimit?: number

        Maximum number of members to be retrieved.

        Note: Telegram currently only allows you to ever retrieve at most 200 members, regardless of offset/limit. I.e. when passing offset=201 nothing will ever be returned.

        Default

        200
      • Optionaloffset?: number

        Sequential number of the first member to be returned.

      • Optionalquery?: string

        Search query to filter members by their display names and usernames

        Note: Only used for these values of filter: all, banned, restricted, mention, contacts

        Default

        '' (empty string)

      • Optionaltype?:
            | "restricted"
            | "contacts"
            | "bots"
            | "banned"
            | "admins"
            | "mention"
            | "all"
            | "recent"

        Type of the query. Can be:

        • all: get all members
        • banned: get only banned members
        • restricted: get only restricted members
        • bots: get only bots
        • recent: get recent members
        • admins: get only administrators (and creator)
        • contacts: get only contacts
        • mention: get users that can be mentioned (see tl.RawChannelParticipantsMentions)

        Only used for channels and supergroups.

        Default

        recent

    Returns Promise<ArrayWithTotal<ChatMember>>

Settings

Member Visibility