Methods

api.getSupergroupMembers()

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

Parameters GetSupergroupMembersParams:

Parameters

Interface

Name	Type	Description
`supergroupId`	`number`	Identifier of the supergroup or channel
`filter`	SupergroupMembersFilterInputUnion	The type of users to return; pass null to use supergroupMembersFilterRecent
`offset`	`number`	Number of users to skip
`limit`	`number`	The maximum number of users be returned; up to 200

Returns ApiResponse interface:

interface ApiResponse {
  _: 'getSupergroupMembers' | 'error'
  airgram: Airgram
  request: {
    method: 'getSupergroupMembers'
    params: GetSupergroupMembersParams
  }
  response: ChatMembersUnion
 | Error
  setState: (nextState: Record<string, unknown>) => void
  getState: () => Record<string, unknown>
}