All Products
Search
Document Center

Mobile Platform as a Service:Create a message – Multiple push

Last Updated:Oct 23, 2023

Important

Since March 18th, 2022, mPaaS MPS console has been upgraded. On the new console, the push types have been integrated and optimized from the previous four types (simple push, template push, multiple push and broadcast push) to two types (simple push and multiple push). The upgraded simple push covers the capabilities of the original simple push and template push; the upgraded multiple push covers the capabilities of the original multiple push and broadcast push.

Multiple push is mainly used to push messages to a large number of users to meet some operation needs.

The multiple push falls into network-wide push and non network-wide push.

  • Network-wide push refers to pushing the same template-based message to all Android and iOS networking devices, which only supports pushing by devices.

    When you push a message to Android devices, all the Android devices that are connected in the message validity period can receive the message; when you push a message to iOS devices, all the iOS devices that are bound in the message validity period can receive the message.

  • Non network-wide push refers to pushing the same template-based message to specified user groups.

    You can manually upload a group of message receivers, customize tagged user groups, or use the MAS groups.

Note
  • The messages are pushed immediately after they are created. You cannot delete or modify them.

  • Since manual operations are required, we recommend you push messages through the console in the scenarios requiring low-frequency message push, such as system verification, operation support, and temporary emergency requirement.

The following sections describe how to create a multiple push message in the console.

Prerequisites

  • To push messages to iOS devices, you should have integrated MPS iOS SDK (see Integrate iOS SDK) and configured the iOS push certificate on the Channel configuration page in mPaaS console. For more information, see Configure iOS push channel.

  • To push messages through the Android vendor channels (also known as third-party channels), you should have integrated MPS Android SDK (see Integrate Android SDK), accessed relevant vendor channels (see Integrate vendor push channels) and completed corresponding push channel setting on the Channel configuration page in mPaaS console. For more information, see Channel configuration.

  • Before creating a multiple push task, you need to prepare a template. For how to create a template, see Create a message template.

  • When you create a multiple push task, if you choose to call the MAS group as the target audiences, you should create a MAS group in advance. For details, see Create user groups. If you choose a tagged user group as the target audiences, you should create a tagged user group in advance. For details, see Create a user tag.

Procedure

  1. Log in to the mPaaS console, select the target app, and go to the Message Push Service > Message management page.

  2. Click the Create message push task button, and in the pop-up dialog box, select the Multiple push tab.

  3. On the multiple push tab page, configure the basic information of the message. The configuration items are as follows:

    Parameter

    Required

    Description

    Message type: silent message

    Yes

    Whether to display the message:

    • Yes: Indicates that the message will not be displayed in any form on the target device, and user has no sense about it.

    • No: Indicates that the message will be displayed in the notification bar.

    For Android devices, you need to perform different operations according to the push channel that you have selected:

    • MPS channel: This parameter is sent to the client as a reference field. You need to parse the message body and get the content of this field, then control the display of the message.

    • Vendor channel: This parameter is sent to the target device as a field. The device vendor's system will then parse the content of this field, and control the display of the message. You do not need to perform any other operations.

    For iOS devices, the display of messages is controlled by the device vendor’s system. You do not need to perform any other operations.

    Push dimension

    Yes

    Select the message delivery mode:

    • Users: Push messages by user ID. You need to call the bind API to bind the user ID with device ID. For more information about the binding API, see Client APIs.

    • Devices: Push messages by device ID.

    Push platform

    Yes

    When you choose the push dimension as Devices, you need to select a push platform to specify the type of the target device.

    • Android: MPS provides vendor channels and MPS self-build channel to push the message to the network-wide online Android devices (in valid period) or specified Android devices. The message will be pushed only once for each device.

    • iOS: Use the vendor channel to push the message to the network-wide or specified iOS devices. The message will be pushed only once for each device.

    Select push targets

    Yes

    • When you choose the push dimension as Users, you have the following options:

      • Upload a group: Upload the file containing target IDs and the personalized configuration of each target ID based on the selected template. Every data record in the file represents a message, which is identified by a customer message ID. Requirements for the file format are as follows:

        • The format of each data record: target ID,customer message ID,placeholder 1=XXX;placeholder 2=XXX…, where the customer message ID can be user customized.

        • The file encoding type must be UTF-8 and the maximum file size is 200 MB. Separate multiple data records with line breaks. Each data record must be 1~250 characters in length. Only one file can be uploaded in one push task.

          After a file is successfully uploaded, its icon is displayed below the Upload button. You can preview up to 10 data records of the file by clicking the icon.

      • MAS group: Call the MAS group and push the same message to the specified group users. You need to create a MAS group first. For details, see Create user groups. If the message template includes any placeholder, this option is unavailable.

      • User tags: Select the target groups by tag. You should create a tagged user group first. For details, see Create a user tag.

    • When you choose the push dimension as Devices, you have the following options:

      • All devices: Push the message to all devices of the selected platform.

      • Partial devices: Upload the file containing target IDs and the personalized configuration of each target ID based on the selected template. Every data record in the file represents a message, which is identified by a customer message ID. Requirements for the file format are as follows:

        • The format of each data record: target ID,customer message ID,placeholder 1=XXX;placeholder 2=XXX…, where the customer message ID can be user customized.

        • The file encoding type must be UTF-8 and the maximum file size is 200 MB. Separate multiple data records with line breaks. Each data record must be 1~250 characters in length. Only one file can be uploaded in one push task.

          After a file is successfully uploaded, its icon is displayed below the Upload button. You can preview up to 10 data records of the file by clicking the icon.

      • MAS group: Call the MAS group and push the same message to the specified group users. You need to create a MAS group first. For details, see Create user groups. If the message template includes any placeholder, this option is unavailable.

    Template

    Yes

    Choose a message template from templates listed on the Message templates page.

    Template placeholder

    Yes

    Enter variable values in the template. The system provides configuration options for placeholders in the selected template.

    Push priority of Android message channels

    Yes

    Only available for Android push platform.

    • Vendor channels preferred: Vendor channels are preferred. If vendor channels are integrated, messages are pushed through the corresponding vendor channels; if no vendor channel is integrated to the app, the messages are pushed through MPS self-built channel.

    • MPS channel: MPS uses the self-built channel to push messages.

    For Android devices, this parameter specifies whether to push messages through an MPS self-built channel or vendor channel. For iOS devices, you do not need to set this parameter (iOS push belongs to vendor channel push).

    Push mode

    Yes

    Select the time to push 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.

    The preview area is on the right side of the message creation window. To preview the message display effects for different platforms respectively, click Notification, iOS message body and Android message body.

  4. (Optional) Configure the advanced information on demand. In the Advanced information 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).

    • Login status: Specify target users according to login status. When you select the login/logout period, Permanent means no time limit, namely pushing messages to all login/logout users.

      Important

      Login status is unconfigurable when you use Android push platform and push messages through MPS self-built channel.

      • If you select Login users, MPS will push messages to the users who logged in to the App in the specified time period. For example, if the login period is 15 days, it means pushing messages to the users who logged in to the App in recent 15 days.

      • If you select Logout users, MPS will push messages to the users who logged out from the App in the specified time period. For example, if the logout period is 15 days, it means pushing messages to the users who logged out in recent 15 days.

      • If you select both Login users and Logout users, MPS will push messages to the users who logged in to the App and logged out in the specified time period. For example, if the login period is permanent while the logout period is 7 days, it means pushing messages to all login users and the users who logged out in recent 7 days.

    • 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.

    • Valid period: Specify the valid period of the message in seconds. It is 180 seconds by default. To ensure the message arrival rate, when a message fails to be sent because the device is offline or the user is logged out, MPS will resend it after the device is connected or a user binding request is initiated within the validity period of the message.

    • 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.

      Extension parameters include the following three types:

      • System extension parameters

        These extension parameters are occupied by the system, and cannot be modified. System extension parameters include notifyTypeactionsilentpushTypetemplateCodechannel, and taskId.

      • System extension parameters with some significance

        These extension parameters are occupied by the system and have some significance. You can configure values of these extension parameters.

        For more information about these parameters, see the following table.

        Parameter

        Description

        sound

        The custom ringtone of the message. The value of this parameter is the path of the ringtone. This parameter is only valid for Xiaomi phones and iPhones.

        badge

        Badge number. Its value is a specific number. This extension parameter will be passed to the client together with the message body.

        • For Android devices, you need to implement the badge logic by yourself.

        • For iOS devices, iOS system automatically implements the badge logic. When a message is pushed to the target mobile phone, the number that you specified in value appears in the badge of the App icon.

        mutable-content

        The APNs custom push identifier. If a pushed message carries this parameter, it indicates that the UNNotificationServiceExtension of iOS10 is supported, otherwise it is a normal push. The value is set to 1.

        badge_add_num

        Accumulative badge number, only available in Huawei channel.

        badge_class

        Activity class corresponding to the desktop App icon in Huawei channel.

        big_text

        Big text style, the value is fixed to 1, and other values are invalid. This parameter is only valid for Xiaomi and Huawei phones.

      • User-defined extension parameters

        All other parameters than system extension parameters and system extension parameters with some significance are user-defined extension parameters. User-defined extension parameters are passed to the client together with the message body for your use.

  5. Click Submit to complete creating the message. The new message will appear in the multiple push records.

In addition to console operation, you can also push messages by calling relevant APIs. For more information, see Server APIs.

Relevant operations