Prerequisites
In the Production environment, this service is only available for Chat Premium and Chat Ultimate plans.
How to enable
Go to Console > App Configuration > Chat pricing plans to enable this service.
When you enable this service, provide a valid callback URL. If your network restricts access by IP, you must add our IPs to your allowlist to get callbacks.
This is a paid feature, but it’s free in the development environment.
How it works
The Post-messaging Callback service syncs message data from one-to-one chats, groups, ultra groups, and chatrooms to your app server. (Discussion groups and customer service messages are deprecated.) For media messages like images and videos, you can download the files from the provided URL. We store these files for 6 months.
Use cases
- Store chat history: Sync user messages to your app server in real time for storage.
- Data migration: Smoothly migrate from a third-party messaging service. When your new client (with our SDK) messages an old client (with the third-party SDK), our server uses this callback to call the third-party’s server API, delivering the message to the old client. For details, see our guide on Migrating to RC.
APIs Associated with Post-messaging Callback
| Feature Name | Feature Description | Activation Method |
|---|---|---|
| Blocked message callback to app server | By default, messages containing blocked sensitive words are not synchronized to the application server. If messages contain replaceable sensitive words, the sensitive words in the messages will be replaced with the configured content and synchronized to the application server. After enabling this feature, messages containing blocked sensitive words will also be synchronized to the application server. | Console |
| Post-messaging callback for status messages | If the client uses the “typing status” feature for one-to-one chat conversations, the typing status messages will also be routed and stored in message logs. Please enable this feature with caution due to high message volume. If the Enable server API Message Delivery Callback service is not enabled, the Post-messaging Callback will only be activated for status messages sent by the client. | Console |
| Enable server API Message Delivery Callback | After enabling, messages sent by server API will be delivered to the client server through routing. | Console |
| Whether ultra group message extensions are routed | In ultra group conversations, when setting extensions for messages, whether the extension information is included in Post-messaging Callback. Default is not routed. The message type for ultra group extension messages is RC:MsgExMsg. | Submit a ticket |
If you have any questions about this feature, feel free to submit a ticket to us.