外观
获取会话列表
约 294 字小于 1 分钟
2025-03-25
1. 描述
getConversationList() 获取会话列表,该方法为异步函数,调用后会返回一个 Promise 对象,通过该对象可以获取到会话列表。
2. 参数
无
3. 返回值
返回一个 Promise 对象,成功时resolve 回调函数返回会话列表数组,失败时reject 回调函数返回错误信息。
| 字段 | 类型 | 说明 |
|---|---|---|
| type | String | 会话类型,single 单聊,group 群聊 |
| name | String | 名称,群聊时为群聊名称,单聊时为对端用户名称 |
| avatar | String | 头像,群聊时为群聊头像,单聊时为对端用户头像 |
| conversationId | String | 会话ID,群聊时为群聊ID,单聊时为会话ID |
| profile | String | 资料对象字符串,群聊时为最后发送消息的用户资料,单聊时为对端用户资料 |
| unreadCount | Number | 未读消息数量 |
| lastMessage | Object | 最后一条消息 |
| groupId | String | 群聊ID,会话为群聊时存在 |
| isAt | Number | 群聊时存在,是否有人@我,0 无,1 有 |
4. 示例代码
XBCIM.getConversationList().then((conversationList) => {
console.log('获取会话列表成功', conversationList);
}).catch((error) => {
console.log('获取会话列表失败', error);
});