Channel configuration

This document provides detailed procedures for configuring these push channels.

Android push channels

To improve delivery rates, mPaaS integrates with third-party push channels from vendors like HUAWEI, Xiaomi, OPPO, and vivo. This integration lets you send notification messages via vendor-native services. Users receive these notifications even when the app is closed and can tap them to launch it.

This topic guides you through configuring the push channels for Xiaomi, HUAWEI, OPPO, and vivo in the mPaaS console.

• Configure the HUAWEI push channel

• Configure the HONOR push channel

• Configure the Xiaomi push channel

• Configure the OPPO push channel

• Configure the vivo push channel

• Configure the FCM push channel

• Configure the new FCM channel

Prerequisites

Complete the client-side integration. For instructions, see Integrate third-party push channels.

Procedure

HUAWEI push channel

1. In the left navigation pane, choose Message Push > Settings > Channel configuration.

2. In the HUAWEI push channel section, click Configure in the upper-right corner. The configuration dialog box appears, as shown in the following figure.

   

   Parameter	Required	Description
   Status	Yes	Enables or disables the HUAWEI push channel integration for Message Push Service (MPS).
   Package name	Yes	The package name of your HUAWEI app.
   HUAWEI App ID	Yes	The App ID of your HUAWEI app.
   HUAWEI App Secret	Yes	The App Secret of your HUAWEI app.
   Vendor receipt	Yes	Enables or disables support for vendor receipts in MPS.

   Note

   Log on to the HUAWEI Developers website and navigate to the Management Center > My Products > Mobile App Details page to obtain your app's package name, App ID, and App Secret.

3. Click OK to save the configuration.

HONOR push channel

1. In the left navigation pane, choose Message Push > Settings > Channel configuration.

2. In the HONOR push channel section, click Configure in the upper-right corner. The configuration dialog box appears, as shown in the following figure:

   

   Parameter	Required	Description
   Status	Yes	Enables or disables the HONOR push channel integration for Message Push Service (MPS).
   Package name	Yes	The package name of your HONOR app.
   HONOR App ID	Yes	A unique identifier for your app, generated when you enable the HONOR Push service on the developer platform.
   HONOR Client ID	Yes	The app's Client ID, used to obtain a token for sending messages. It is generated when you enable the PUSH service on the developer platform.
   HONOR Client Secret	Yes	The Client Secret of your HONOR app.
   Vendor receipt	Yes	Enables or disables support for vendor receipts in MPS.

   Note

   You can log in to the Honor Developer Alliance official website and obtain the package name, App ID, and secret key from the Management Center > My Products > Mobile App Details page.

3. Click OK to save the configuration.

Xiaomi push channel

1. In the left navigation pane, choose Message Push > Settings > Channel configuration.

2. In the Xiaomi push channel section, click Configure in the upper-right corner. The configuration dialog box appears, as shown in the following figure.

   

   Parameter	Required	Description
   Status	Yes	Enables or disables the Xiaomi push channel integration for Message Push Service (MPS).
   Package name	Yes	The primary package name of your Xiaomi app.
   AppSecret	Yes	The AppSecret of your Xiaomi app.
   Vendor receipt	Yes	Enables or disables support for vendor receipts in MPS.
   Callback URL	No	Required if you enable vendor receipts. The callback URL must use the HTTPS protocol.

   Note

   Log on to Mi Developer and navigate to the App Management > App Information page to obtain the package name and AppSecret.

3. Click OK to save the configuration.

OPPO push channel

1. In the left navigation pane, choose Message Push > Settings > Channel configuration.

2. In the OPPO push channel section, click Configure in the upper-right corner. The configuration dialog box appears, as shown in the following figure.

   

   Parameter	Required	Description
   Status	Yes	Enables or disables the OPPO push channel integration for Message Push Service (MPS).
   AppKey	Yes	An identifier for the client, used during the initialization of the client-side SDK.
   MasterSecret	Yes	An identifier used to authenticate your server-side API calls.
   Vendor receipt	Yes	Enables or disables support for vendor receipts in MPS.
   Callback URL	No	Required if you enable vendor receipts. The callback URL must use the HTTPS protocol.

   Note

   After enabling OPPO push permissions on the OPPO Open Platform, you can find the AppKey and MasterSecret on the Configuration Management > Application Configuration page in the OPPO push platform.

3. Click OK to save the configuration.

vivo push channel

1. In the left navigation pane, choose Message Push > Settings > Channel configuration.

2. In the vivo push channel section, click Configure in the upper-right corner. The configuration dialog box appears, as shown in the following figure.

   

   Parameter	Required	Description
   Status	Yes	Enables or disables the vivo push channel integration for Message Push Service (MPS).
   App ID	Yes	An identifier for the client, used during the initialization of the client-side SDK.
   AppKey	Yes	An identifier for the client, used during the initialization of the client-side SDK.
   MasterSecret	Yes	An identifier used to authenticate your identity when you call server-side APIs. This parameter corresponds to the AppSecret you obtained from the vivo Developers Platform.
   Vendor receipt	Yes	Enables or disables support for vendor receipts in MPS.
   Callback URL	No	Required if you enable vendor receipts. The callback URL must use the HTTPS protocol.

   Note

   After your application for the push service is approved on the vivo Developers Platform, you can obtain the AppID, AppKey, and MasterSecret (AppSecret) for your app.

3. Click OK to save the configuration.

FCM push channel

To send notifications to Android devices in overseas regions, you must configure the FCM push channel, which uses Google's FCM service as the notification gateway.

Prerequisites

Before you configure the FCM push channel, you must obtain an FCM server key from the Firebase console. The following figure shows how to obtain the key.

Procedure

1. In the left navigation pane, choose Message Push > Settings > Channel configuration.

2. In the FCM push channel section, click Configure in the upper-right corner to configure the channel, as shown in the following figure.

3. Click the Status switch. When enabled, MPS integrates with the FCM service. When disabled, MPS does not connect to the FCM service.

4. Enter the FCM Server Key. Ensure that you enter the server key. FCM will reject Android keys, iOS keys, and browser keys.

5. Click OK to save the configuration.

New FCM channel

1. Upload the FCM authentication file through the console.

   

   Firebase projects support Google service accounts, which you can use to call Firebase server APIs from your app server or trusted environments. For local development and deployment, use the credentials from this service account to authorize server requests.

   Note

   To authenticate a service account and authorize its access to Firebase services, generate a private key file in JSON format.

   1. In the Firebase console, select Settings > Service accounts.

   2. Click Generate new private key, and then confirm by clicking Generate Key.

   3. Securely store the JSON file that contains the key.

2. Switch the push pipeline.

   The method to switch links by using the new FCM logic is to configure the extended parameters (extended_params). Add the key-value pair useNewFcmApi=1 to specify that messages are pushed through the new link.

   

   When sending a push message, add the extended parameter:

   • Legacy API: useNewFcmApi, 0

   • New API: useNewFcmApi, 1

   If you do not add the extended parameter, the system defaults to the legacy API.

iOS push channel

To send notifications to Apple devices, you must upload an iOS push certificate in the console. This certificate connects your application to the Apple Push Notification service (APNs).

Follow these steps to configure the iOS push certificate:

1. Log on to the mPaaS console, select your target application, and then from the left navigation pane, choose Message Push > Settings.

2. On the settings page that appears, select the Channel configuration tab. In the iOS channel section, configure the iOS push certificate.

   • Select certificate file: Select and upload your iOS push certificate. The backend parses the uploaded certificate to obtain the environment and Bundle ID. To learn how to create an iOS push certificate, see Create an iOS push certificate.

   • Certificate password: Enter the password you set when exporting the .p12 certificate.

3. Click Upload to save the configuration. If the certificate format is correct, you can view its details, as shown in the following figure. To verify that the certificate is valid and matches the environment, you can send a test message from the console.

iOS Live Activities certificate

Follow these steps to configure the iOS Live Activities message push certificate:

1. Log on to the mPaaS console, select your target application, and then from the left navigation pane, choose Message Push > Settings.

2. On the settings page for the iOS Channel, select the Token authentication configuration checkbox. Configure the bundleId, keyId, and teamId, then upload the p8AuthKey private key file (the .p8 file), and click Save.

   

   Important

   • To learn how to create a p8AuthKey private key file, see Create an iOS P8 Live Activities certificate.

   • The environment for Live Activities message pushes is tied to the original iOS certificate:

     • If the original iOS certificate is for the sandbox environment, sandbox Live Activities messages will be pushed.

     • If the original iOS certificate is for the production environment, production Live Activities messages will be pushed.

Callback URLs

Currently, vendor receipts are supported by HUAWEI, HONOR, HarmonyOS, Xiaomi, OPPO, and vivo.