Browse SDKs · HarmonyOS
Platform
SDKsHarmonyOSEnterprise

Get specified group members info

Query group member profile information by user IDs in a target group.

Copy

Queries member profiles for specified users within a particular group.

Code example

import sdk, {
  GetSpecifiedGroupMembersInfoReq,
  GetSpecifiedGroupMembersInfoResp,
} from '@openimsdk/imsdk';

const request: GetSpecifiedGroupMembersInfoReq = {
  groupID: groupID,
  userIDs: ['user_001', 'user_002'],
};
const response: GetSpecifiedGroupMembersInfoResp = await sdk.getSpecifiedGroupMembersInfo(request);
const members = response.members;

Parameters

ParameterTypeRequiredDescription
groupIDstringYesTarget group identifier.
userIDsstring[]YesArray of user IDs to query.

Return value

Returns a Promise resolving to GetSpecifiedGroupMembersInfoResp:

PropertyTypeDescription
membersGroupMemberItem[]List of member profiles matching the requested user IDs.

State changes after the call

The returned array order is not guaranteed to match the input ID sequence. Because nicknames, roles, and mute states differ across groups for the same user, clients should index and cache member data using groupID:userID. This query does not trigger events; to listen for member changes, see Retrieve group member list.