Report Push Notification Data

RC provides push statistics functionality, allowing you to view the statistical data of push services on the Push Success Rate Statistics page in the Console.

tip

The push data statistics feature is only available for production environments of launched applications. For applications in global data centers, please complete the configuration based on the SDK version to ensure data is reported to the correct data center. For details, refer to the knowledge base document RC Global Data Center Usage Guide.

Push data statistics include:

Total Push Volume: Indicates the actual number of notifications that need to be pushed, including vendor pushes and RC pushes.
Total Successful Pushes: Indicates the number of notifications successfully pushed to third-party push vendors or RC Push services. A successful push does not necessarily mean the notification has been delivered to the target device.
Total Failed Pushes: Indicates the number of notifications that failed to be pushed to third-party push vendors or RC Push services.
Total Push Arrivals (requires configuration): Indicates the number of notifications actually received by mobile devices. Some systems require the device to actively report arrival data. Currently, only push arrival data for one-to-one chat and group chat conversation types is supported. Push arrival data for ultra groups and push-only notifications is not supported.
Total Push Clicks (requires configuration): Indicates the total number of notifications clicked by end-users. Some systems require the device to actively report click data.

Due to differences in push service designs among various mobile vendors, RC cannot directly obtain push arrival and click data from some vendors. You need to configure this on the third-party push platform or have the client report it manually.

Check SDK Initialization Timing

If the RC SDK has not completed initialization when the user clicks a push notification, the SDK will be unable to report push data.

It is recommended that you check the components that need to be initialized in the Application during integration and initialize the RC SDK as early as possible to ensure accurate reporting of push-related data.

Collect Push Arrival Data

Push arrival refers to the successful delivery of a notification to the target device after it has been sent to the third-party vendor push channel or RC Push service.

Huawei and Meizu push arrival data rely on the "delivery receipt" service provided by the mobile vendor's push channel. Google FCM only supports collecting push arrival data for transparent message push methods. For detailed support, see the table below:

Push Platform	Provides Push Arrival Data	Configuration Required
Huawei	Vendor-supported	Yes, see Configure Huawei Push Receipt
Honor	Vendor-supported	Yes, see Configure Honor Push Receipt
Meizu	Vendor-supported	Yes, see Configure Meizu Push Receipt
Xiaomi	Vendor-supported	No configuration required
Vivo	Vendor-supported	No configuration required
OPPO (including Realme, OnePlus)	Vendor-supported	No configuration required
Google FCM	Not vendor-supported, provided by RC SDK	See Collect FCM Push Arrival Data

Configure Huawei Push Receipt

tip

Before configuring, ensure that Huawei Push integration is complete.

After completing the Huawei push channel configuration and integration, developers need to enable and configure message receipts on the Huawei Developer Platform to obtain Huawei push delivery data. For details, refer to the Huawei Developer Platform Message Receipt Guide. The configuration process is as follows:

Log in to the Huawei Developer Platform, select the corresponding application in the Push development service, and enter the push configuration page.
After entering the configuration interface, enable Application Receipt Status.
Click Create Receipt and configure the following parameters.
- Receipt Name: Enter a custom name.
- Callback URL: Ensure to configure the corresponding push receipt callback URL based on the data center of the application.
  - China (Beijing) Data Center (recommended): https://callback.rong-edge.com/push/callback/huawei
  - China (Beijing) Data Center (legacy): https://callback-bj.ronghub.com/push/callback/huawei
  - Singapore Data Center Callback URL: https://callback.sg-light-edge.com/push/callback/huawei
  - Singapore B Enterprise Data Center: https://callback.sg-b-light-edge.com/push/callback/huawei
  - North America Data Center Callback URL: https://callback.us-light-edge.com/push/callback/huawei
  - Saudi Arabia Data Center Callback URL: https://callback.sau-light-edge.com/push/callback/huawei
- Callback Username: Leave blank
- Callback Secret Key: Leave blank
- Supported Versions: Both V1 and V2 versions are supported. It is recommended to select V2. Customers who have configured V1 on the Huawei platform are advised to switch to V2 as soon as possible.
After configuration, click Test Receipt. If the test is successful, click Submit to complete the configuration.

Configure Honor Push Receipt

tip

Before configuring, ensure that Honor Push integration is complete.

After completing the Honor push channel configuration and integration, developers need to enable and configure message receipts on the Honor Developer Platform to obtain Honor push delivery data. For details, refer to the Honor Push Service Message Receipt Guide. The configuration process is as follows:

Log in to the Honor Developer Service Platform, select Management Center > Ecosystem Services > Development Services > Push Service, and enter the push service page. Select the application that needs to be configured for receipts, click Application Receipt, and enter the application receipt page.
Click Add Receipt to enter the receipt configuration page.

Configure the following information:
- Receipt Name: A custom name, no more than 50 characters.
- Callback URL: Ensure to configure the corresponding push receipt callback URL based on the data center of the application.
  - China (Beijing) Data Center (recommended): https://callback.rong-edge.com/push/callback/honor
  - China (Beijing) Data Center (legacy): https://callback-bj.ronghub.com/push/callback/honor
  - Singapore Data Center Callback URL: https://callback.sg-light-edge.com/push/callback/honor
  - Singapore B Enterprise Data Center: https://callback.sg-b-light-edge.com/push/callback/honor
  - North America Data Center Callback URL: https://callback.us-light-edge.com/push/callback/honor
  - Saudi Arabia Data Center Callback URL: https://callback.sau-light-edge.com/push/callback/honor
- Callback Username: Leave blank
- Callback Secret Key: Leave blank
- Receipt Scope: Check both Arrival Receipt and Click Receipt.

Configure Meizu Push Receipt

tip

Before configuring, ensure that Meizu Push integration is complete.

After completing the Meizu push channel integration, developers need to create a receipt on the Meizu Push Platform and then enable "Meizu Push Arrival Receipt" in the RC Console to obtain Meizu channel delivery data. The configuration process is as follows:

Log in to the Meizu Push Platform, select the application that needs to be configured for receipts, and click Open Application.
After entering the application, select Configuration Management > Receipt Management, and add a Callback URL.

Beijing Data Center Callback URL: https://callback-bj.ronghub.com/push/callback/meizu
After setting the callback URL on the Meizu platform, you need to enable Push Arrival Receipt in the Meizu Push configuration in the RC Console to obtain Meizu channel delivery data.

Collect FCM Push Arrival Data

tip

Before configuring, ensure that FCM Push integration is complete.
Confirm that the FCM push method is configured as transparent message. RC does not support collecting push arrival data for notification message methods.
Confirm that the appropriate statistical service is configured. For configuration methods, refer to: RC Global Data Center Usage Guide.

Push arrival data for FCM is only supported when the FCM push method is configured as transparent message in the RC Console.

The app needs to manually report FCM push arrival data as follows:

Call RongPushClient.setPushEventListener to set a push event listener, and call RongPushClient.recordPushArriveEvent in the interface method preNotificationMessageArrived to report push arrival data.

        RongPushClient.setPushEventListener(
                new PushEventListener() {
                    @Override
                    public boolean preNotificationMessageArrived(
                            Context context,
                            PushType pushType,
                            PushNotificationMessage notificationMessage) {
                        RongPushClient.recordPushArriveEvent(
                                context, pushType, notificationMessage);
                        return false;
                    }

                    ...
                });

Collect Push Click Data

Push click data refers to the total number of notifications clicked by end-users.

RC can directly obtain click data from most vendor push channels. If the RC client SDK version is lower than 5.2.3, Huawei push channel notification click data needs to be manually reported by the client.

For detailed support, see the table below:

Push Platform	Push Click Event Reporting	Description
RongPush	Supported	RC SDK implements the reporting logic by default
Xiaomi	Supported	RC SDK implements the reporting logic by default
Huawei	Supported (requires SDK ≧ 5.1.4)	Starting from IMLib 5.2.3, RC SDK implements the reporting logic by default (versions below this require manual click event reporting)
Honor	Supported	RC SDK implements the reporting logic by default
Vivo	Supported	RC SDK implements the reporting logic by default
Meizu	Supported	RC SDK implements the reporting logic by default
OPPO	Supported	RC SDK implements the reporting logic by default
Google FCM	Supported	RC SDK implements the reporting logic by default

Collect Huawei Push Click Data

tip

Before configuring, ensure that Huawei Push integration is complete. Starting from SDK 5.1.4, Huawei push click data collection is supported. Versions below this cannot collect push click data.

Starting from SDK 5.2.3, RC SDK internally reports Huawei push click data by default, and no action is required from you.

If the RC client SDK version is lower than 5.2.3, you need to manually report Huawei push notification click data as follows:

If the Huawei push intent in the console uses the default value and is not customized, call the following method in the onCreate() of the conversation list page activity:

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    		if(intent != null && intent.getData() != null
           && intent.getData().getScheme() != null
           && intent.getData().getScheme().equals("rong")
           && intent.getData().getQueryParameter("isFromPush") != null
           && intent.getData().getQueryParameter("isFromPush").equals("true")) {
             RongPushClient.recordHWNotificationEvent(intent); //Report click event
           }
        ...
    }

If the Huawei push intent is customized, intercept the intent in the custom activity and call the following reporting method.
```
RongPushClient.recordHWNotificationEvent(intent);
```

Appendix: RC Callback Service HTTPS Certificate

If a push platform requires the HTTPS certificate of the callback server, you can use the following certificate.

(Recommended) Update the Beijing data center callback URL to https://callback.rong-edge.com/push/callback/huawei. The corresponding HTTPS certificate is as follows (valid until 2024-11-28):

If you continue to use the legacy Beijing data center callback URL https://callback-bj.ronghub.com/push/callback/huawei, you need to update to the latest HTTPS certificate promptly (valid until 2024-11-28):

IMLib

IMKit

Global Chat UIKit

push notification

IMLib

Global Chat UIKit

CallLib

CallKit

RTCLib

Chat Server

Chat Server SDK

Audio & Video Server

Check SDK Initialization Timing​

Collect Push Arrival Data​

Configure Huawei Push Receipt​

Configure Honor Push Receipt​

Configure Meizu Push Receipt​

Collect FCM Push Arrival Data​

Collect Push Click Data​

Collect Huawei Push Click Data​

Appendix: RC Callback Service HTTPS Certificate​