Search group members

Call searchGroupMembers() to search members of a group by user ID or group nickname.

const members = await OpenIMSDK.searchGroupMembers({
  groupID: 'group-001',
  keywordList: ['Zhang'],
  isSearchUserID: false,
  isSearchMemberNickname: true,
  offset: 0,
  count: 50,
});

Parameters

| Parameter | Type | Required | Description | | --- | --- | --- | | groupID | string | Yes | ID of the target group. | | keywordList | string[] | Yes | Search keywords. | | isSearchUserID | boolean | Yes | Whether to match user IDs. | | isSearchMemberNickname | boolean | Yes | Whether to match group nicknames. | | offset | number | Yes | Pagination offset. Use 0 for the first page. | | count | number | Yes | Number of members to retrieve. |

Return value

When the call completes, it returns matching GroupMemberItem[] entries for the current page. See Group overview for field descriptions.