Mobile Platform as a Service:Create a message - Simple push

Simple push sends a message to a single target. You can either customize the message content or use a pre-created message template.

Customizing message content is suitable for scenarios with a few targets, such as testing the validity of an Apple push certificate or verifying the integration of the Android push SDK. Message templates are suitable for scenarios that involve pushing to multiple targets multiple times. You can create a template-based push message in the console to validate and test the template feature before using it for automation or large-scale pushes.

This topic describes how to create a simple push message in the console.

Prerequisites

• Before pushing messages to iOS devices, integrate the MPS SDK for iOS. For more information, see iOS SDK integration. Also, configure the push certificate for Apple devices on the Channel Configuration page in the console. For more information, see Configure the iOS push channel.

• Before pushing messages using Android vendor channels, integrate the MPS SDK for Android and the relevant vendor channels. For more information, see Android SDK integration. Also, complete the corresponding push channel configurations on the Channel Configuration page in the console. For more information, see Configure Android push channels.

Procedure

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

2. Click Create Message Push Task. In the dialog box that appears, select the Simple Push tab.

3. On the Simple Push tab, configure the basic information for the push message. The parameters are described as follows:

   Parameter	Required	Description
   Message type: Silent	Yes	Specifies whether to display the message: Yes: The message is silent. The user is not aware of the message, and it is not displayed on the target device in any form. No: The message is displayed in the notification bar. For the Android platform, perform different follow-up operations based on the push channel: MPS channel: This parameter is sent to the client as a reference field. You need to parse the message body, get the value of this field, and then control the message display as needed. Vendor channel: After this parameter is sent to the target device, the vendor's system parses the field and controls the message display. No other action is required. On the iOS push platform, message display is a system behavior that requires no other operations.
   Message content creation method	Yes	Supports two creation methods: Create: Customize the message content, including the title, body, and display style. Use template: Use a pre-created push template.
   Push template	Yes	Select a message template. You can select any template from the list on the Message Template page of the current application. Note This parameter is required only when Message content creation method is set to Use template.
   Template placeholder	Yes	Enter the values for the variables in the template. The system provides configuration entries based on the placeholders in the selected template.
   Push dimension	Yes	Select the message delivery mode. The options are: Users: Push messages based on user IDs. You need to call the binding API to attach user IDs to device IDs. For more information about the binding API, see Client API. Android: Push messages based on Android device IDs. iOS: Push messages based on iOS device IDs.
   User/Device ID	Yes	Enter the corresponding user ID or device ID based on the selected push dimension. If the push dimension is Android dimension, enter the Ad-token. If the push dimension is iOS dimension, enter the Device Token. If the push dimension is User dimension, enter the user ID. This is the userid value passed when the user calls the binding API. If the device ID obtained from logs or other sources contains spaces, you must remove them.
   Push priority of Android message channels	Yes	This applies only to the Android platform. The options are: Vendor channels preferred: The system prioritizes vendor channels to push messages. For integrated vendor channels, the message is sent through the corresponding vendor channel service. For non-integrated vendor channels, the message is sent through the MPS self-built channel. MPS channel: The message is pushed using the MPS self-built channel. For the Android platform, this parameter is the entry for selecting between the MPS channel and vendor channels. You do not need to configure this parameter for iOS and HarmonyOS platforms because they use vendor channels for pushes.
   Display style	Yes	The display style of the message on the client. The supported styles are Default, Big Text, and Image with Text. Default: This style displays the push title and text. Use it for simple and clear messages. The message text should be no more than 100 characters long, including custom parameters and symbols. Big Text: This style displays the push title and text. Use it for messages with more text, such as news or information updates. This lets users get information quickly without opening the application. The message text should be no more than 256 characters long, including custom parameters and symbols. Rich text: This style supports messages with icons and large images. Use it for rich content that goes beyond plain text. For the best display, the message text should not be longer than two lines. Note You need to configure this parameter only when the message content creation method is Create.
   Message title	Yes	Enter the message title. In the preview area to the right of the New Push Message text box, you can preview the display effect after the message is delivered. Note This parameter is required only when Message content creation method is set to Create.
   Message content	Yes	Enter the message body. In the preview area to the right of the New Push Message text box, you can preview the display effect after the message is delivered. Note This parameter is required only when Message content creation method is set to Create.
   Icon	No	The icon displayed to the right of the message content in the notification bar. It supports JPG, JPEG, and PNG formats. Enter the URL of a publicly accessible icon asset. If you do not upload assets for each vendor channel and only upload a default asset URL, the system automatically pulls the default asset to display the icon for each vendor channel. However, because vendor channels have different requirements for assets, it is recommended to upload assets separately for each channel to avoid poor display effects. Default icon: Recommended size is 140 × 140 px, within 50 KB. OPPO icon: Recommended size is 140 × 140 px, within 50 KB. Xiaomi icon: Recommended size is 120 × 120 px, within 50 KB. Huawei icon: Recommended size is 40 × 40 dp, within 512 KB. FCM icon: No specific configuration requirements. The system automatically pulls the default icon for adaptation. Note This parameter is required only when Message content creation method is set to Create and Display style is set to Rich Text.
   Large message image	No	The image displayed below the message content in the notification bar. Enter the URL of a publicly accessible large image asset. If you do not upload assets for each vendor channel and only upload a default asset URL, the system automatically pulls the default asset to display the large image for each vendor channel. However, because vendor channels have different requirements for assets, it is recommended to upload assets separately for each channel to avoid poor display effects. Default large image: Recommended size is 876 × 324 px, within 1 MB. Supports JPG, JPEG, and PNG formats. OPPO large image: Recommended size is 876 × 324 px, within 1 MB. Supports JPG, JPEG, and PNG formats. Xiaomi large image: Recommended size is 876 × 324 px, within 1 MB. Supports JPG, JPEG, and PNG formats. iOS large image: User-defined image with no size restrictions. FCM large image: No specific configuration requirements. The system automatically pulls the default icon for adaptation. Note This parameter is required only when Message content creation method is set to Create and Display style is set to Rich Text.
   Push time	Yes	Select when to push the message: Now: Push the message immediately once the message push task is created. Scheduled: Specify a time to push the message. For example, push the message at 8:00 am on June 19th. Cyclic: Push the message at a specific time cyclically within a period. For example, push the message at 8:00 am every Friday from June 1st to September 30th.

   On the right side of the dialog box is the Push Preview area. You can click Notification, Apple Message Body, Android Message Body, and HarmonyOS Message Body to preview the message display and the message body sent to each platform.

4. (Optional) Configure advanced settings as needed. In the advanced settings area, complete the following configurations:

   • Redirect upon click: Specify the operation to be performed after a user taps the message on the phone. This parameter is sent to the client as a reference field. You need to implement subsequent operations by referring to the field.

     • Web page: Users will be redirected to a Web page.

     • Custom page: Users will be redirected to a native page.

   • Redirection address: The page to be visited after a user taps the message on the mobile phone. Enter the address according to the option you chose.

     • For Web page, enter the URL of the web page to be visited.

     • For custom page, enter the address of the native page to be visited (Android: ActivityName; iOS: VCName).

   • Custom message ID: Custom message ID is automatically generated by the system to uniquely identify the message in the client's system. It can be customized and a maximum of 64 characters are allowed.

   • Note

     You only need to configure a custom ID if the message type is silent.

   • Validity period: The validity period of the message, in seconds. If a message fails to be delivered because a device is offline or a user is logged out, MPS resends the message when the device reconnects or a user binding request is initiated within the validity period. This ensures a higher delivery rate. If this parameter is not set, the default validity period is 180 seconds.

     Note

     The message validity period cannot be shorter than 180 seconds or longer than 72 hours.

   • Extension parameters: Turn the switch on, click Add parameter, set the key/value, and left click on any area of the page to complete setting. The extension parameters are passed to the client together with the message body for your use. Extended parameters include the following three types:

     • System extended parameters

       These parameters are reserved by the system, and their values cannot be modified. They include notifyType, action, silent, pushType, templateCode, channel, and taskId.

     • System extended parameters with special meanings

       These parameters are reserved by the system and have special meanings. You can configure the values for these parameters. The following table describes these parameters.

       Parameter	Description
       sound	Custom ringtone. The parameter value is the path to the ringtone file. This parameter is effective only for Xiaomi and Apple phones.
       badge	Application icon badge number. The parameter value is a specific number. This parameter is sent with the message body to the client. For Android phones, you need to handle the logic for implementing the badge. For Apple phones, the system automatically implements the badge. After the message is pushed to the target phone, the application icon badge will display the configured value.
       mutable-content	APNs custom push identifier. Including this parameter in a push indicates support for UNNotificationServiceExtension in iOS 10. If this parameter is not included, it is a normal push. Set the parameter value to 1.
       badge_add_num	The number to add to the badge for Huawei channel pushes.
       badge_class	The application's entry Activity class corresponding to the desktop icon for the Huawei channel.
       big_text	Big text style. The parameter value is fixed at 1. Other values are invalid. This parameter is effective only for Xiaomi and Huawei phones.

     • User-defined extended parameters

       Any parameters (keys) that are not system extended parameters or system extended parameters with special meanings are user-defined extended parameters. These parameters are sent with the extended parameters in the message body to the client for custom processing.

5. Click Submit. The created message appears in the simple message record list.

   You can also push messages by calling APIs. For more information, see Server-side API reference.

Related operations

• Create a message - Batch push

• Manage simple push messages

• Manage scheduled push tasks