Conversation Management
Sync User Conversations
Sync user’s conversation list and status
POST
Overview
Sync user’s conversation list and status, supporting both incremental and full synchronization.Request Body
Required Parameters
User ID
Optional Parameters
Version timestamp for incremental sync
Client’s last message sequence numbers, format: channelID:channelType:last_msg_seq|channelID:channelType:last_msg_seq
Number of recent messages to return for each conversation
Whether to return only unread conversations (1=only unread, 0=return all)
Array of channel types to exclude
Channel type
Response Fields
The response is an array of conversations, each containing the following fields:Conversation Information
Channel ID
Channel type
1- Personal channel2- Group channel
Number of unread messages
Last message timestamp
Last message sequence number
Conversation version number (nanosecond timestamp)
Message List
List of latest messages in the conversation
Status Codes
| Status Code | Description |
|---|---|
| 200 | Conversation sync successful |
| 400 | Request parameter error |
| 403 | No access permission |
| 500 | Internal server error |
Parameter Details
Message Count (msg_count)
Controls the number of messages returned for each conversation:| Value | Description | Use Case |
|---|---|---|
| 0 | No messages returned | Only need conversation list |
| 1-50 | Return specified number | Normal usage |
| > 50 | System limited to 50 | Avoid excessive data |
Version-based Incremental Sync
Use version parameter for efficient incremental synchronization:Last Message Sequence Tracking
Track message sequences to detect missed messages:Use Cases
Chat List Display
Initial Load:Real-time Sync
Periodic Sync:Offline Recovery
Sync After Reconnection:Best Practices
- Incremental Sync: Use version-based incremental sync to reduce data transfer
- Appropriate Message Count: Set reasonable msg_count based on UI needs
- Error Handling: Handle network errors and implement retry logic
- Caching: Cache conversation data locally to improve performance
- Real-time Updates: Combine with WebSocket events for real-time updates
- Filtering: Use exclude_channel_types to filter out unwanted channel types
- Batch Processing: Process conversation updates in batches for better performance

