Skip to main content

Message Management Service Configuration

Basic Features​

The following configurations related to message management functions of the Server API are available on the Basic Features page in the Console:

  • Sensitive Word Filtering for Messages Sent via Server API: Controls whether the sensitive word mechanism is enabled for messages sent via the Server API.
  • Real-time Routing for Messages Sent via Server API: When enabled, messages sent via the Server API will also undergo post-messaging callback. This only takes effect if the Post-messaging Callback is already activated.
  • Historical Message Log Download via Server API: The IM service can save historical message records of all conversations within the APP. Historical message records are provided in the form of log files, which are compressed. You can use the Server API to obtain the historical message logs for a specified App. Note that the Server API interface only returns the download link for the message record file. After obtaining the link, you need to download it yourself.

Enable Services​

Visit the Basic features page in the Console to enable the above features:

Chat Premium Plan/Chat Ultimate Plan​

The following configurations related to message management functions of the Server API are available on the Chat pricing plans page in the Console:

  • Post-messaging Callback: The Post-messaging Callback supports synchronizing message data from one-to-one chats, groups, ultra groups, and chatrooms to the designated application server. When activating the service, you need to configure a callback receiving address that is accessible. Note:
    • To enable post-messaging callback for ultra group message extensions, please submit a ticket.
    • To enable post-messaging callback for messages containing blocked sensitive words, please submit a ticket to apply for activation.
    • To enable post-messaging callback for status messages sent by the client, please submit a ticket to apply for the One-to-One Status Message Routing Function. If you need to enable post-messaging callback for any messages sent via the Send One-to-One Status Message or Send Group Status Message interfaces, you need to activate the Real-time Routing for Messages Sent via Server API service.
    • To enable post-messaging callback for ultra group message extension changes, please submit a ticket to apply for adjusting Whether Ultra Group Message Extensions Are Routed. After activating the service, if the ultra group message extensions are changed, the server will generate a message of type RC:MsgExMsg. The new message is only used for message routing synchronization and will not be synchronized to the client SDK. The new message ID is generated by the server, and the originalMsgUID field will carry the MsgUID of the original message. Note that the extension data carried when the message is sent cannot be obtained through post-messaging callback.
  • Cloud Storage for One-to-One and Group Messages: Stores historical message records of one-to-one chats, group chats, and system conversations on the IM service.
  • Multi-Device Message Synchronization: Enables message synchronization between multiple devices under the same user account. If you need to synchronize messages sent via the Server API to the offline client of the sender, it is recommended to enable this feature.

Modify Service Configuration​

Visit the Chat pricing plans page in the Console, and you can enable the above services under the General Services tab. In the development environment, these services can be used for free. The Chat Premium Plan or Chat Ultimate Plan can activate these services. Specific features and fees are subject to the Billing Instructions document.

Last updated on