外观
获取群聊成员列表
约 311 字大约 1 分钟
2025-03-25
1. 描述
getGroupMemberList()
获取群聊成员列表,该方法为异步函数
,调用后会返回一个 Promise
对象,通过该对象可以获取群聊成员列表。
2. 参数
参数名称 | 是否必选 | 类型 | 说明 |
---|---|---|---|
groupId | 是 | String | 群聊ID |
keywords | 否 | String | 关键词,用于筛选群成员,不填则返回全部群成员 |
page | 否 | Number | 页码,用于分页获取群聊列表 ,默认为 1 |
pageSize | 否 | Number | 每页数量,用于分页获取群聊列表,默认为 20 |
3. 返回值
返回一个 Promise
对象。
字段 | 类型 | 说明 |
---|---|---|
list | Array | 成员列表数组,格式见下 |
isComplete | Number | 是否加载完,0-否,1-是 |
- list 字段说明:
字段 | 类型 | 说明 |
---|---|---|
groupId | String | 群聊ID |
userId | String | 群主ID |
userAvatar | String | 成员头像 |
userName | String | 成员名称 |
userEmail | String | 成员邮箱(加密后) |
userPhone | String | 成员手机号(加密后) |
userGender | String | 成员性别,unknown-未知,male-男,female-女 |
isAdmin | Number | 是否为管理员,0-否,1-是 |
isOnline | Number | 是否在线-否,1-是 |
4. 示例代码
XBCIM.getGroupMemberList({
groupId: 'xxxxxxx',
keywords: 'keyword',
page: 1,
pageSize: 20,
}).then((members) => {
console.log('群聊成员列表', members);
}).catch((error) => {
console.log('获取群聊成员列表失败', error);
});