[**RongIMLib**](../README.md)

***

[RongIMLib](../globals.md) / getGroupMembersByRole

# Function: getGroupMembersByRole()

> **getGroupMembersByRole**(`groupId`, `role`, `option`): `Promise`\<[`RCResult`](../interfaces/RCResult.md)\<[`IPagingQueryResult`](../interfaces/IPagingQueryResult.md)\<[`IGroupMemberInfo`](../interfaces/IGroupMemberInfo.md)\>\>\>

分页获取群成员信息

## Parameters

### groupId

`string`

群组 Id。

### role

[`GroupMemberRole`](../enumerations/GroupMemberRole.md)

群成员角色数组。参照[GroupMemberRole](../enumerations/GroupMemberRole.md) 0:不区分角色或位置角色获取所有群成员

### option

[`IGetGroupMembersOption`](../interfaces/IGetGroupMembersOption.md)

分页拉取参数。参照[IPagingQueryOption](../interfaces/IPagingQueryOption.md), 一页最多查询 100 条数据

## Returns

`Promise`\<[`RCResult`](../interfaces/RCResult.md)\<[`IPagingQueryResult`](../interfaces/IPagingQueryResult.md)\<[`IGroupMemberInfo`](../interfaces/IGroupMemberInfo.md)\>\>\>

返回一个 [RCResult](../interfaces/RCResult.md) 类型 Promise，data 为包含群成员总数和群成员信息，群成员信息为 [IGroupMemberInfo](../interfaces/IGroupMemberInfo.md) 类型

## Description

需要开启 `信息托管功能` 功能，否则不支持此功能

## Since

5.12.0