Skip to content

分页查询用户会话

1. 接口定位

  • 接口名称: 分页查询用户会话
  • 所属域: conversation
  • 业务目标: 按用户 ID 分页查询该用户的会话列表

2. 请求定义

  • Method: POST
  • Path: /conversation/get_owner_conversation
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 必填,需要通过 Header token 传入有效令牌
  • 幂等性: 幂等(只读操作)

3. 请求参数

Header 参数

字段必填类型说明
operationIDstring链路追踪 ID
tokenstring登录令牌

Body 参数

字段必填类型说明
userIDstring会话所属用户 ID
paginationobject分页参数

pagination 字段

字段必填类型说明
pageNumberint32页码(从 1 开始)
showNumberint32每页条数

字段约束

  • userID 不能为空。
  • 未传 pagination 时由服务端按默认分页策略处理。

4. 响应结构

通用响应包裹

字段类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简述
errDltstring错误详情
dataany业务数据

data 字段结构

字段类型说明
totalint64会话总数
conversationsarray会话列表

conversations 元素(Conversation)

字段类型说明
ownerUserIDstring会话归属用户 ID
conversationIDstring会话 ID
conversationTypeint32会话类型(单聊/群聊等)
userIDstring单聊对端用户 ID(单聊时)
groupIDstring群组 ID(群聊时)
recvMsgOptint32接收消息选项
isPinnedbool是否置顶
isPrivateChatbool是否私密会话
groupAtTypeint32群 @ 类型
minSeqint64会话最小可见消息序号
maxSeqint64会话最大可见消息序号
burnDurationint32阅后即焚持续时长
msgDestructTimeint64消息焚毁时间(毫秒时间戳)
latestMsgDestructTimeint64最新焚毁消息时间(毫秒时间戳)
isMsgDestructbool是否开启消息焚毁
attachedInfostring扩展信息
exstring自定义扩展字段

5. 业务规则

  • 接口按 userID 查询会话,不传会话 ID。
  • 返回 total 用于前端分页总数展示。
  • 会话对象主要返回会话配置与序号边界,不包含消息正文。

6. 错误码与失败场景

错误码场景典型报错
1001参数不合法(如 userID 为空)ArgsError
1002无权限访问NoPermissionError
500服务内部错误ServerInternalError

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10002/conversation/get_owner_conversation", {
  method: "POST",
  headers: {
    operationID: "e40f4f53-3c1a-4bd2-9e4e-772d927f8296",
    token: "<your-token>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    userID: "u_1001",
    pagination: {
      pageNumber: 1,
      showNumber: 20,
    },
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "userID": "u_1001",
  "pagination": {
    "pageNumber": 1,
    "showNumber": 20
  }
}

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 2,
    "conversations": [
      {
        "ownerUserID": "u_1001",
        "conversationID": "si_u_1001_u_1002",
        "conversationType": 1,
        "userID": "u_1002",
        "recvMsgOpt": 0,
        "isPinned": false,
        "minSeq": 1,
        "maxSeq": 1024,
        "isPrivateChat": false
      }
    ]
  }
}

8. 时序流程

  1. 校验请求并读取分页参数。
  2. userID 从会话库分页查询会话数据。
  3. 组装 total + conversations 返回。

9. 变更记录

  • 2026-07-06: 新增 get_owner_conversation 文档。