Synchronize command messages
Operation boundary
- Caller: Trusted backend only
- Scope: Messages come from durable storage, but the latest acknowledgement generation is kept only in the handling process memory, by default for about 5 minutes and at most 4,096 UIDs.
- Success: limit bounds returned messages, not the total cost of enumerating command Channels and scanning messages.
- Recovery: Keep sync and syncack node-affine; run sync again after process restart, expiry, or eviction.
Deprecated
POST
/message/syncReturns the latest durable CMD generation; message_seq is accepted but ignored.
Request Body
application/json
User and page limit for command-message synchronization.
TypeScript Definitions
Use the request body type in TypeScript.
Legacy command-message synchronization parameters.
Response Body
application/json
application/json
application/json
[ { "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" }]