服务端 API
概述
会话模块用于后端读取和维护用户会话数据,包括排序会话、单个会话、批量会话、分页读取用户会话和批量设置会话。
能力范围
| 能力 | 说明 |
|---|---|
| 会话读取 | 获取排序会话列表、单个会话、批量会话或分页读取用户会话。 |
| 会话设置 | 批量设置会话属性和扩展数据。 |
| 会话分组 商业版 | 创建、更新、删除和查询用户会话分组,维护分组顺序及分组中的会话。 |
常用接口
资源表示
会话模块当前只维护会话资料这一类稳定资源对象。排序会话列表中的摘要对象暂不放入概述,等服务端对外结构体命名稳定后再补充。
ConversationInfo
ConversationInfo 表示一个用户侧会话。
| 字段 | 类型 | 说明 |
|---|---|---|
| ownerUserID | string | 会话所属用户 ID。 |
| conversationID | string | 会话 ID。 |
| conversationType | int | 会话类型,参见 ConversationType。 |
| userID | string | 单聊目标用户 ID。 |
| groupID | string | 群聊目标群 ID。 |
| recvMsgOpt | int | 收消息选项,参见 RecvMsgOpt。 |
| isPinned | boolean | 是否置顶会话。 |
| attachedInfo | string | 会话附加信息。 |
| isPrivateChat | boolean | 是否为私聊会话。 |
| groupAtType | int | 群会话 @ 状态,参见 GroupAtType。 |
| ex | string | 会话扩展字段。 |
| burnDuration | int | 阅后即焚时长。 |
| minSeq | int64 | 当前用户侧会话最小消息序列号。 |
| maxSeq | int64 | 当前用户侧会话最大消息序列号。 |
| msgDestructTime | int64 | 消息销毁时间。 |
| latestMsgDestructTime | int64 | 最新消息销毁时间。 |
| isMsgDestruct | boolean | 是否开启消息销毁。 |
| isMarked 商业版 | boolean | 是否标记该会话。 |
| remark 商业版 | string | 当前用户为会话设置的备注。 |
ConversationGroup
ConversationGroup 表示商业版中的用户会话分组。会话分组接口均为商业版接口。
| 字段 | 类型 | 说明 |
|---|---|---|
| conversationGroupID | string | 会话分组 ID。 |
| ownerUserID | string | 分组所属用户 ID。 |
| name | string | 分组名称。 |
| order | int64 | 分组展示顺序。 |
| version | int64 | 分组版本号。 |
| ex | string | 业务扩展字段。 |
| conversationIDs | string[] | 分组中的会话 ID 列表。 |
| hidden | boolean | 是否隐藏该分组。 |
| conversationGroupType | int | 分组类型,参见 ConversationGroupType。 |
| createTime | int64 | 创建时间,Unix 毫秒时间戳。 |
ConversationGroupOrder
ConversationGroupOrder 表示商业版会话分组的排序设置。
| 字段 | 类型 | 说明 |
|---|---|---|
| conversationGroupID | string | 会话分组 ID。 |
| order | int64 | 目标展示顺序。 |
枚举
ConversationType
ConversationType 也用于消息和 Webhooks 中的 sessionType,字段值保持一致。
| 值 | 名称 | 说明 |
|---|---|---|
| 1 | SingleChatType | 单聊。 |
| 2 | WriteGroupChatType | 写群聊类型;当前服务端暂不建议直接使用。 |
| 3 | ReadGroupChatType | 群聊。 |
| 4 | NotificationChatType | 通知会话。 |
RecvMsgOpt
| 值 | 名称 | 说明 |
|---|---|---|
| 0 | ReceiveMessage | 接收消息。 |
| 1 | NotReceiveMessage | 不接收消息。 |
| 2 | ReceiveNotNotifyMessage | 接收消息,但不触发通知。 |
GroupAtType
| 值 | 名称 | 说明 |
|---|---|---|
| 0 | AtNormal | 没有 @ 提醒。 |
| 1 | AtMe | @ 当前用户。 |
| 2 | AtAll | @ 全体成员。 |
| 3 | AtAllAtMe | 同时 @ 全体成员和当前用户。 |
| 4 | GroupNotification | 群通知。 |
ConversationGroupType
| 值 | 名称 | 说明 |
|---|---|---|
| 0 | Normal | 普通会话分组。 |
| 1 | Filter | 筛选分组。 |
接入建议
会话数据通常用于后台管理、数据修复和多端同步辅助,不建议由客户端直接调用管理端接口。
批量设置会话前应确认目标用户和会话 ID 的归属关系,避免误改其他用户会话。
相关页面
这个页面有帮助吗?