WuKongIM Docs

Synchronize one Channel's committed messages

Operation boundary

  • Caller: Trusted backend only
  • Scope: The login_uid must have an ordinary membership before reading; join_seq and deleted_to_seq establish the lowest visible sequence. Returned messages are always ordered by ascending message_seq.
  • Success: pull_mode=1 reads [start_message_seq, end_message_seq); other values read older messages in (end_message_seq, start_message_seq]. A zero boundary selects the open end.
POST/channel/messagesync

Checks membership visibility and returns an ascending page; limit is 100 by default and capped at 10000.

Request Body

application/json

Committed-message read criteria for one Channel.

TypeScript Definitions

Use the request body type in TypeScript.

Single-Channel committed-message synchronization parameters.

Response Body

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"    }  ]}