Skip to main content

How to Synchronize Sent Messages on the Client Side

When the app backend calls the IM Server API to send messages, it usually expects that the sender's client can also synchronize the sent messages. For example:

  • When the sender's client is online, messages sent via the Server API can be automatically synchronized to the sender's client devices.
  • When the sender's offline client comes back online, it can automatically retrieve messages sent via the Server API.
  • When the sender's client pulls historical messages, it can always retrieve messages sent via the Server API.

You can achieve the above requirements through the following methods:

tip

By default, RC does not synchronize messages sent via the Server API to the sender's client, nor does it store these sent messages in the sender's server-side historical message records.

Setting the isIncludeSender Parameter​

When calling the IM Server API's message sending interface, set the isIncludeSender parameter to 1. This ensures that the sent messages are synchronized to the sender's client when the client is online. Some interfaces support the isSyncSender parameter, which has the same effect.

If this parameter is not passed, the server uses the default value 0, meaning no synchronization, and the sender's client cannot retrieve the sent message.

The following interfaces support isIncludeSender:

The following interfaces support isSyncSender:

Enabling Multi-Device Message Synchronization​

When sending messages via the Server API, the sender's client may be offline. In this case, even if the isIncludeSender parameter is set to 1, the server cannot synchronize messages sent via the Server API to the client in real time.

If you need the sender's client to automatically synchronize sent messages from the server when it comes back online, you need to enable the Multi-Device Message Synchronization feature. After enabling this feature, messages sent via the Server API will be synchronized to the client through the offline message compensation mechanism. When the client comes back online, it will automatically synchronize messages from the past 1 natural day (including the current day) by default.

You can enable Multi-Device Message Synchronization from the Console. For details, see Message Management Service Configuration.

Since chatroom and ultra group services do not support offline compensation, this method only supports the following one-to-one and group chat interfaces:

Enabling Historical Message Cloud Storage Service​

The app may also need to retrieve messages sent via the Server API when pulling historical messages. For example, after sending a message via the Server API, the sender may not log in to the client for a long time, causing the sent messages stored in offline compensation to expire. Or, due to a misoperation by the sender on the client, messages sent via the Server API may be deleted locally.

To meet the above requirements, it is recommended that the app also enable the historical message cloud storage service.

  • Cloud Storage for One-to-One and Group Messages: After enabling, one-to-one, group, and system conversation messages sent via the Server API can be stored in the sender's server-side historical message records, with a default retention period of 6 months. Note that the isIncludeSender parameter must be set to 1 when sending messages for storage.
  • Cloud Storage for Chatroom Messages: After enabling, chatroom messages sent via the Server API can be stored in the sender's server-side historical message records, with a default retention period of 2 months. Note that the isIncludeSender parameter must be set to 1 when sending messages for storage.

You can enable these services from the Console. For details, see Message Management Service Configuration.

Exceptions​

The IM service does not support storing [chatroom broadcast messages] in the server-side chatroom historical message records. Therefore, chatroom broadcast messages are only synchronized when the sender has logged in to the client (online).

After the ultra group service is enabled, historical message storage is enabled by default, with no need for additional enabling. Historical messages from the past 7 days are stored by default. The ultra group message sending interface does not support setting the isIncludeSender parameter. When the sender pulls historical messages, messages sent via the Server API will be included.

Last updated on