外观
获取群聊列表
约 275 字小于 1 分钟
2025-03-25
1. 描述
getGroupList()
获取群聊列表,该方法为异步函数
,调用后会返回一个 Promise
对象,通过该对象可以获取群聊列表。
2. 参数
参数名称 | 是否必选 | 类型 | 说明 |
---|---|---|---|
keywords | 否 | String | 关键词,用于筛选群聊名称 |
page | 否 | Number | 页码,用于分页获取群聊列表 ,默认为 1 |
pageSize | 否 | Number | 每页数量,用于分页获取群聊列表,默认为 20 |
3. 返回值
返回一个 Promise
对象,成功时resolve
的参数为群聊列表数组,失败时reject
的参数为错误信息。
字段 | 类型 | 说明 |
---|---|---|
list | Array | 群聊列表数组,格式见下 |
isComplete | Number | 是否加载完,0-否,1-是 |
- list 字段说明:
字段 | 类型 | 说明 |
---|---|---|
groupId | String | 群聊ID |
name | String | 群聊名称,默认成员昵称拼接 |
avatar | String | 群聊头像 |
users | Number | 群聊人数 |
userId | String | 群主ID |
4. 示例代码
XBCIM.getGroupList({
keywords: 'xxx',
page: 1,
pageSize: 20
}).then((groupList) => {
console.log('群聊列表获取成功', groupList);
}).catch((error) => {
console.log('群聊列表获取失败', error);
});