Receiving Server Callbacks
Overview of Server Callbacks
The IM service provides the following server callbacks to synchronize business data and status notifications to your designated callback address. All server callbacks must be enabled in the Console.
You can refer to the following documents to learn how to configure and enable callbacks in the Console, as well as how to parse callback data:
- User Online Status: Synchronizes user status in real-time to the designated App server address.
- User Deactivation and Activation Status Callback: Synchronizes the processing results to the designated App server address after deactivating or reactivating a user ID.
- Post-messaging Callback: Synchronizes messages in real-time to the designated App server address.
- Pre-messaging Callback: Forwards messages that meet custom conditions to the designated App server address in real-time and decides whether to send them to the target user based on the App server's response.
- Chatroom Status Update Callback: Synchronizes chatroom status changes in real-time to the designated App server.
- Chatroom Custom Attributes Synchronization (KV): Synchronizes custom attribute changes in chatrooms in real-time to the designated App server.
- Audit Result Callback: Synchronizes the audit results of IM & RTC Moderation in real-time to the designated App server address.
Setting Up an IP Allowlist
If your network has IP access restrictions, make sure to add the following IP addresses to your allowlist; otherwise, you won’t be able to receive server callbacks.
- China (Beijing) Data Center: 39.105.128.42, 39.105.147.30, 123.56.88.42, 182.92.215.38, 182.92.84.148, 39.106.150.151, 39.107.75.101, 101.201.34.95, 39.106.2.63, 101.200.62.251, 47.93.57.144 (Console)
- Global Data Center: 52.221.93.74 (Singapore), 8.219.168.45 (Singapore), 8.219.93.148 (Singapore), 8.219.215.35 (Singapore), 8.219.43.97 (Singapore), 47.245.124.194 (Singapore), 8.222.167.17 (Singapore), 8.222.202.67 (Singapore), 43.156.138.254 (Singapore), 43.163.81.196 (Singapore), 43.156.239.53 (Singapore), 52.41.206.152 (North America), 8.213.17.80 (Saudi Arabia), 8.213.16.171 (Saudi Arabia), 8.213.28.96 (Saudi Arabia)
The following IP addresses are no longer in use. If they are included in your IP allowlist, please remove them. 120.92.12.217, 120.92.12.60, 120.92.12.253, 120.92.12.113, 120.92.12.29, 120.92.12.214, 120.92.12.164, 120.92.12.153, 120.92.12.204, 120.92.12.138, 120.92.13.82, 120.92.13.83, 120.92.13.84, 120.92.13.85, 120.131.13.147, 117.50.18.131, 106.75.117.2, 47.94.106.191
Verifying Callback Signatures
The IM service adds four POST request parameters when pushing data to your App server.
- Path Parameters (Signature parameters are in the POST request URL): User Online Status, Post-messaging Callback, Chatroom Status Update Callback, Pre-messaging Callback, Chatroom Custom Attributes Synchronization (KV), User Deactivation and Activation Status Callback
- HTTP Headers (Signature parameters are in the HTTP request headers): Audit Result Callback
| Parameter | Type | Description |
|---|---|---|
| appKey | String | The App Key for the application and environment, which can be obtained from the Console. Exception: The POST request path for Pre-messaging Callback does not include this parameter; you can use the appKey field in the callback request body instead. |
| nonce | String | A random string, no more than 18 characters. |
| timestamp | String | A timestamp in milliseconds since January 1, 1970, 00:00:00 UTC. |
| signature (Data Signature) | String | The data signature. Concatenate the App Secret, Nonce (random string), and Timestamp in order, then perform an SHA1 hash calculation. |
Example Code for Calculating Signature
Here’s an example in PHP:
$appSecret = 'your-own-app-secret'; // Replace with your App Secret from the developer platform.
$nonce = $_GET['nonce']; // Get the random string.
$timestamp = $_GET['timestamp']; // Get the timestamp.
$signature = $_GET['signature']; // Get the data signature.
$local_signature = sha1($appSecret.$nonce.$timestamp); // Generate the local signature.
if(strcmp($signature, $local_signature)===0){
// TODO: Add your business logic here.
echo 'OK';
} else {
echo 'Error';
}