WuKongIM Docs

同步一页会话

编辑此页报告文档问题

接口边界

  • 调用方:仅限受信业务后端
  • 作用域:limit 限制本页扫描的 membership 条目数,不保证 conversations 数组达到该数量;墓碑进入 deletes;最新消息和未读数基于 Leader 已落盘数据,读取不激活运行时。任一读取失败则整页失败,使用原请求和原游标重试。
  • 成功判定:只以 done=true 结束完整轮次并保存 coverage;reset_required=true 时必须重建本地会话目录。
  • 恢复:摘要包含末条消息的最新修改;503 unavailable 保留游标重试。内容修改不改变会话排序或未读。
POST/conversation/list

读取 Leader 已落盘消息,不激活运行时;发送失败的消息也可显示。任一读取错误则整页失败,使用原请求和原游标重试。

请求主体

application/json

会话目录分页与删除覆盖参数。

TypeScript 定义

在 TypeScript 中使用 request body 类型。

会话目录分页参数。

响应主体

application/json

application/json

application/json

application/json

{  "conversations": [    {      "channel_id": "string",      "channel_type": 1,      "active_at": 0,      "read_seq": 0,      "deleted_to_seq": 0,      "unread": 0,      "last_message": {        "message_id": 0,        "message_idstr": "string",        "message_seq": 0,        "from_uid": "string",        "client_msg_no": "string",        "server_timestamp_ms": 0,        "payload": "string",        "version": "string",        "updated_at_ms": 0      }    }  ],  "deletes": [    {      "channel_id": "string",      "channel_type": 1    }  ],  "next_cursor": "string",  "done": true,  "coverage": 0,  "tombstones_retained_since": 0,  "reset_required": true}