浏览 平台 API
服务端 API

概述

复制

会话模块用于后端读取和维护用户会话数据,包括排序会话、单个会话、批量会话、分页读取用户会话和批量设置会话。

能力范围

能力说明
会话读取获取排序会话列表、单个会话、批量会话或分页读取用户会话。
会话设置批量设置会话属性和扩展数据。
会话分组 商业版创建、更新、删除和查询用户会话分组,维护分组顺序及分组中的会话。

常用接口

资源表示

会话模块当前只维护会话资料这一类稳定资源对象。排序会话列表中的摘要对象暂不放入概述,等服务端对外结构体命名稳定后再补充。

ConversationInfo

ConversationInfo 表示一个用户侧会话。

字段类型说明
ownerUserIDstring会话所属用户 ID。
conversationIDstring会话 ID。
conversationTypeint会话类型,参见 ConversationType
userIDstring单聊目标用户 ID。
groupIDstring群聊目标群 ID。
recvMsgOptint收消息选项,参见 RecvMsgOpt
isPinnedboolean是否置顶会话。
attachedInfostring会话附加信息。
isPrivateChatboolean是否为私聊会话。
groupAtTypeint群会话 @ 状态,参见 GroupAtType
exstring会话扩展字段。
burnDurationint阅后即焚时长。
minSeqint64当前用户侧会话最小消息序列号。
maxSeqint64当前用户侧会话最大消息序列号。
msgDestructTimeint64消息销毁时间。
latestMsgDestructTimeint64最新消息销毁时间。
isMsgDestructboolean是否开启消息销毁。
isMarked 商业版boolean是否标记该会话。
remark 商业版string当前用户为会话设置的备注。

ConversationGroup

ConversationGroup 表示商业版中的用户会话分组。会话分组接口均为商业版接口。

字段类型说明
conversationGroupIDstring会话分组 ID。
ownerUserIDstring分组所属用户 ID。
namestring分组名称。
orderint64分组展示顺序。
versionint64分组版本号。
exstring业务扩展字段。
conversationIDsstring[]分组中的会话 ID 列表。
hiddenboolean是否隐藏该分组。
conversationGroupTypeint分组类型,参见 ConversationGroupType
createTimeint64创建时间,Unix 毫秒时间戳。

ConversationGroupOrder

ConversationGroupOrder 表示商业版会话分组的排序设置。

字段类型说明
conversationGroupIDstring会话分组 ID。
orderint64目标展示顺序。

枚举

ConversationType

ConversationType 也用于消息和 Webhooks 中的 sessionType,字段值保持一致。

名称说明
1SingleChatType单聊。
2WriteGroupChatType写群聊类型;当前服务端暂不建议直接使用。
3ReadGroupChatType群聊。
4NotificationChatType通知会话。

RecvMsgOpt

名称说明
0ReceiveMessage接收消息。
1NotReceiveMessage不接收消息。
2ReceiveNotNotifyMessage接收消息,但不触发通知。

GroupAtType

名称说明
0AtNormal没有 @ 提醒。
1AtMe@ 当前用户。
2AtAll@ 全体成员。
3AtAllAtMe同时 @ 全体成员和当前用户。
4GroupNotification群通知。

ConversationGroupType

名称说明
0Normal普通会话分组。
1Filter筛选分组。

接入建议

会话数据通常用于后台管理、数据修复和多端同步辅助,不建议由客户端直接调用管理端接口。

批量设置会话前应确认目标用户和会话 ID 的归属关系,避免误改其他用户会话。

相关页面