外观
获取会话详情
约 430 字大约 1 分钟
2025-03-25
1. 描述
getConversationDetail()
获取会话详情,该方法为异步函数
,调用后会返回一个 Promise
对象,通过该对象可以获取到会话详情。
2. 参数
参数名称 | 是否必选 | 类型 | 说明 |
---|---|---|---|
conversationType | 是 | TYPE | 会话类型,CONVERSATION_TYPE.GROUP 或 CONVERSATION_TYPE.SINGLE |
conversationId | 否 | String | 会话ID,当 conversationType 为 CONVERSATION_TYPE.GROUP 时,conversationId 为必填项 |
userId | 否 | String | 用户ID,当 conversationType 为 CONVERSATION_TYPE.SINGLE 时,conversationId和userId 不能同时为空 |
3. 返回值
返回一个 Promise
对象,群聊和单聊返回的数据结构不一样,具体如下:
3.1 群聊会话详情
字段 | 类型 | 说明 |
---|---|---|
groupId | String | 群聊ID |
userId | String | 群主ID |
name | String | 群聊名称 |
avatar | String | 群聊头像 |
users | Number | 群成员数量 |
unreadCount | Number | 未读消息数量 |
lastMessage | Object | 最后一条消息 |
3.2 单聊会话详情
字段 | 类型 | 说明 |
---|---|---|
conversationId | String | 会话ID |
userId | String | 当前登录用户ID |
targetId | String | 对端用户ID |
unreadCount | Number | 未读消息数量 |
lastMessage | Object | 最后一条消息 |
profile | Object | 当前用户资料 |
4. 示例代码
// 获取群聊会话详细
XBCIM.getConversationDetail({
conversationType: XBCIM.CONVERSATION_TYPE.GROUP,
conversationId: 'xxxxxxx'
}).then((conversation) => {
console.log('获取群聊会话详细成功', conversation);
}).catch((error) => {
console.log('获取群聊会话详细失败', error);
});
// 获取单聊会话详细:获取当前登录用户与指定用户ID的单聊会话详细
XBCIM.getConversationDetail({
conversationType: XBCIM.CONVERSATION_TYPE.SINGLE,
userId: 'xxxxxxx'
}).then((conversation) => {
console.log('获取单聊会话详细成功', conversation);
}).catch((error) => {
console.log('获取单聊会话详细失败', error);
});
// 获取单聊会话详细:根据会话ID获取单聊会话详细
XBCIM.getConversationDetail({
conversationType: XBCIM.CONVERSATION_TYPE.SINGLE,
conversationId: 'xxxxxxx'
}).then((conversation) => {
console.log('获取单聊会话详细成功', conversation);
}).catch((error) => {
console.log('获取单聊会话详细失败', error);
});