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

***

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

# Function: searchGroupMembers()

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

根据昵称搜索群成员信息

## Parameters

### groupId

`string`

群组 Id。

### name

`string`

群成员昵称搜索关键字。注意：不能为空最长不超过 64 个字符；支持模糊搜索查询；昵称为空时，默认搜索用户名。搜索字段不可以传递纯空格。

### option

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

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

## Returns

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

## Description

需要开启 `信息托管功能` 功能，否则不支持此功能，Web 平台暂不支持
- 注意：当前用户未在群组中不支持获取群成员信息

## Since

5.12.0