WuKongIM Docs

同步一个 Channel 的已提交消息

编辑此页报告文档问题

接口边界

  • 调用方:仅限受信业务后端
  • 作用域:读取前必须存在 login_uid 的普通成员关系;join_seq 与 deleted_to_seq 共同形成最低可见序号。返回消息始终按 message_seq 升序排列。
  • 成功判定:pull_mode=1 读取 [start_message_seq, end_message_seq);其他值向旧消息读取 (end_message_seq, start_message_seq]。边界为 0 时使用开放端。
  • 恢复:读取页面时包含最新修改;503 unavailable 保留原查询重试。恢复代数增加后重置缓存版本比较。
POST/channel/messagesync

校验成员可见性并返回升序分页;limit 默认 100,最大 10000。

请求主体

application/json

单个 Channel 的已提交消息读取条件。

TypeScript 定义

在 TypeScript 中使用 request body 类型。

单 Channel 已提交消息同步参数。

响应主体

application/json

application/json

application/json

{  "start_message_seq": 0,  "end_message_seq": 0,  "more": 0,  "messages": [    {      "header": {        "no_persist": 0,        "red_dot": 0,        "sync_once": 0      },      "setting": 0,      "message_id": 0,      "message_idstr": "string",      "client_msg_no": "string",      "end": 0,      "end_reason": 0,      "error": "string",      "stream_data": "string",      "event_meta": {        "has_events": true,        "completed": true,        "event_version": 0,        "last_msg_event_seq": 0,        "event_count": 0,        "open_event_count": 0,        "events": [          {            "event_key": "string",            "status": "string",            "last_msg_event_seq": 0,            "snapshot": null,            "end_reason": 0,            "error": "string"          }        ]      },      "event_sync_hint": {        "client_msg_no": "string",        "from_msg_event_seq": 0      },      "message_seq": 0,      "from_uid": "string",      "channel_id": "string",      "channel_type": 0,      "topic": "string",      "expire": 0,      "timestamp": 0,      "payload": "string",      "version": "string",      "updated_at_ms": 0    }  ]}