MassPush

Push type. Valid values:

• MESSAGE: indicates a message.

• NOTICE: indicates a notification.

Device type. Valid values:

• HARMONY: HarmonyOS device

• iOS: iOS device

• ANDROID: Android device

• ALL: When the AppKey is for a legacy dual-platform app, this pushes to both Android and iOS devices simultaneously. When the AppKey is for a new single-platform app, the effect is the same as specifying the device type corresponding to the app type.

Push target. Valid values:

• DEVICE: push by device.

• ACCOUNT: push by account.

• ALIAS: push by alias.

Set based on Target. Multiple values are separated by commas. If the limit is exceeded, you need to split the push into multiple calls.

• Target=DEVICE: values such as deviceid1,deviceid2 (up to 1,000 supported).

• Target=ACCOUNT: values such as account1,account2 (up to 1,000 supported).

• Target=ALIAS: values such as alias1,alias2 (up to 1,000 supported).

Whether to store offline messages/notifications. StoreOffline defaults to false.

If stored, when the user is offline during push, the message will be resent when the user comes online within the expiration time (ExpireTime). ExpireTime defaults to 72 hours. iOS notifications are delivered through the APNs channel and are not affected by StoreOffline.

Specify sending channels. Valid values:

• accs: Alibaba Cloud proprietary channel

• huawei: Huawei channel

• honor: Honor channel

• xiaomi: Xiaomi channel

• oppo: OPPO channel

• vivo: vivo channel

• meizu: Meizu channel

• gcm: Google GCM channel (legacy HTTP)

• fcm: Google Firebase channel (HTTP v1 API)

• apns: APNs channel

• harmony: HarmonyOS channel

Used for scheduled sending. If not set, the default is immediate sending.

The time format follows the ISO 8601 standard and must use UTC time in the format YYYY-MM-DDThh:mm:ssZ.

Expiration time of offline messages/notifications. Used together with StoreOffline. Expired messages will no longer be sent. The maximum retention period is 72 hours. The default is 72 hours.

The time format follows the ISO 8601 standard and must use UTC time in the format YYYY-MM-DDThh:mm:ssZ. The expiration time cannot be earlier than the current time or the scheduled push time plus 3 seconds (ExpireTime > PushTime + 3 seconds). The 3-second buffer accounts for network and system latency. We recommend at least 1 minute for unicast pushes and at least 10 minutes for broadcast and batch pushes.

Custom identifier for the push task. When JobKey is not empty, this field will be included in the receipt logs. For receipt log details, see Receipt Logs.

Title of the notification/message during push. Length limit: 200 bytes. Required for Android and HarmonyOS pushes. Optional for iOS push notifications. If provided:

• iOS 10+: the notification displays the title.

• iOS 8.2 <= iOS version < iOS 10: replaces the notification app name.

Content of the notification/message for Android and HarmonyOS pushes; iOS message/notification content. The push content size is limited. See Product Limits.

Whether to automatically truncate titles and content that are too long. Note: This only applies to vendor channels that explicitly limit title and content length. It does not apply to channels like APNs, Huawei, and Honor that do not limit title and content individually but only limit the total request body size.

iOS notifications are sent through the APNs center. You need to specify the corresponding environment information.

• DEV: Development environment, applicable to apps installed and debugged directly via Xcode.

• PRODUCT: Production environment, applicable to apps distributed through App Store, TestFlight, Ad Hoc, and enterprise distribution.

When the device is offline during message push (i.e., the persistent connection channel to the Mobile Push server is disconnected), this push will be delivered as a notification through Apple's APNs channel once.

iOS notification subtitle content (iOS 10+).

iOS notification content used when converting iOS messages to notifications. Only valid when iOSApnsEnv=PRODUCT and iOSRemind is true.

iOS notification sound. Specify the name of an audio file stored in the app bundle or the sandbox Library/Sounds directory. See: How to set notification sound for iOS push.

If set to an empty string (""), the notification is silent. If not set, the default system alert sound is used.

iOS app icon badge number in the upper-right corner.

Whether to enable badge auto-increment. Defaults to false.

The badge auto-increment feature is maintained by the push server for each device's badge count. Users must use SDK version V1.9.5 or later and actively sync the badge number to the server.

Whether to enable iOS silent notification.

iOS notification processing extension flag (iOS 10+). If set to true, APNs push notifications can reach the Extension for processing before being displayed. Must be set to true for silent notifications.

Specify the iOS notification Category (iOS 10+).

When a device receives messages with the same CollapseId, they are merged into one. When the device is offline, consecutive messages with the same CollapseId will show only one notification in the notification bar. Supported on iOS 10+.

Groups iOS remote notifications using this property, marking the group identifier for collapsed notifications. Only supported on iOS 12.0+.

Interruption level. Valid values:

• passive: The system adds the notification to the notification list without lighting up the screen or playing sound.

• active: The system immediately displays the notification, lights up the screen, and can play sound.

• time-sensitive: The system immediately presents the notification, lights up the screen, and can play sound, but does not break through system notification controls.

• critical: The system immediately displays the notification, lights up the screen, and plays sound bypassing the mute switch.

Summary highlight score. Value range: a floating-point number in [0,1].

Extended properties of iOS notifications.

On iOS 10+, you can specify the resource URL for rich media push notifications here: {"attachment": "https://xxxx.xxx/notification_pic.png"} . This parameter must be passed in JSON map format; otherwise, parsing errors will occur.

Start, update, or end a Live Activity.

• Enum: start | update | end

The Live Activity ID reported by the device to the user's server. A unique identifier for the Live Activity.

The type of Live Activity to start.

JSON string. Static pass-through parameters for Dynamic Island push. Contains static user-defined information such as product ID and order information.

Dynamic pass-through parameters for Dynamic Island push. Contains real-time update information such as price and inventory changes.

The ended Live Activity will remain on the lock screen until the specified time, up to a maximum of 4 hours.

Timestamp in seconds, marking the expiration time of the activity content.

Notification alert type. Valid values:

• VIBRATE: Vibration (default)

• SOUND: Sound

• BOTH: Sound and vibration

• NONE: Silent

When the push type is message and the device is offline, this push will use the auxiliary popup feature. Defaults to false. Only takes effect when PushType=MESSAGE.

If the message-to-notification conversion push is successful, the notification displays the data set by the server's AndroidPopupTitle and AndroidPopupBody parameter values. The data obtained when clicking the notification in the auxiliary popup's onSysNoticeOpened method is the server-set Title and Body parameter values.

Action after clicking the notification. Valid values:

• APPLICATION: Open the app (default)

• ACTIVITY: Open an Android Activity

• URL: Open a URL

• NONE: No navigation

Specify the Activity to open from the notification.

Only applicable when PushTask.N.AndroidOpenType="Activity", e.g., com.alibaba.cloudpushdemo.bizactivity.

The URL to open after Android receives the push. Only applicable when PushTask.N.AndroidOpenType="URL".

Specify the Activity to navigate to when the notification is clicked.

Title content in auxiliary popup mode. Required when the AndroidPopupActivity parameter is not empty.

Length limit: 50 characters (both Chinese and English characters count as one character each).

When using vendor channels, you must also comply with the vendor channel restrictions. For details, see Android Auxiliary Channel Push Limits.

Body content in auxiliary popup mode. Required when the AndroidPopupActivity parameter is not empty.

Length limit: 200 characters (both Chinese and English characters count as one character each).

When using vendor channels, you must also comply with the vendor channel restrictions. For details, see Android Auxiliary Channel Push Limits.

Notification style. Valid values:

• 0: Standard mode (default)

• 1: Long text mode (supported by Huawei, Honor, Xiaomi, OPPO, Meizu, and proprietary channels)

• 2: Big picture mode (supported by proprietary channel, not supported on Xiaomi devices)

• 3: List mode (supported by Huawei, Honor, Xiaomi, OPPO, and proprietary channels)

Title in long text mode. Length limit: 200 bytes (1 Chinese character counts as 3 bytes).

• Currently only supported by the Honor channel and Huawei channel EMUI 11 and later.

• If this parameter is not provided in long text mode, the first non-empty value from Title and AndroidPopupTitle is used.

Body in long text mode. Length limit: 1,000 bytes (1 Chinese character counts as 3 bytes). Subject to specific vendor channel restrictions when sending.

Currently supported:

• Huawei: EMUI 10 and later

• Honor: Magic UI 4.0 and later

• Xiaomi: MIUI 10 and later

• OPPO: ColorOS 5.0 and later

• Meizu: Flyme

• Proprietary channel: Android SDK 3.6.0 and later

If this parameter is not provided in long text mode, the first non-empty value from Body and AndroidPopupBody is used.

Image URL in big picture mode. Currently supported: Proprietary channel: Android SDK 3.6.0 and later.

This parameter has been deprecated. Since August 2023, Xiaomi has officially discontinued support for dynamically setting small icons, right-side icons, and big pictures during push on new devices/systems.

Right-side icon URL. Currently supported:

• Huawei EMUI (only applicable in long text mode and Inbox mode)

• Honor Magic UI (only applicable in long text mode)

• Proprietary channel: Android SDK 3.5.0 and later

This parameter has been deprecated. Since August 2023, Xiaomi has officially discontinued support for dynamically setting small icons, right-side icons, and big pictures during push on new devices/systems.

Body content in Inbox mode. The content must be a valid JSON Array with no more than 5 elements. Currently supported:

• Huawei: EMUI 9 and later

• Honor: Magic UI 4.0 and later

• Xiaomi: MIUI 10 and later

• OPPO: ColorOS 5.0 and later

• Proprietary channel: Android SDK 3.6.0 and later

Android custom notification bar style. Value range: 1-100.

Priority of the notification position in the Android notification bar. Valid values: -2, -1, 0, 1, 2.

Unique identifier for each message displayed in the notification bar. Different notification bar messages can share the same NotifyId, allowing new notifications to replace old ones.

The channelId of the Android app. Must match the channelId configured in the app.

• Set the NotificationChannel parameter. For specific usage, see FAQ: Notifications not received on Android 8.0+ devices.

• Since the OPPO notification private channel's channel_id is the same as the app's channelId, the channel_id takes this value when pushing through the OPPO channel.

• For Huawei, FCM, and Alibaba Cloud proprietary channel pushes, the channel_id takes this value.

Set the Huawei notification message classification importance parameter, which determines the notification behavior on user devices. Valid values:

• LOW: Information and marketing messages

• NORMAL: Service and communication messages

Set the Honor notification message classification importance parameter, which determines the notification behavior on user devices. Valid values:

• LOW: Information and marketing messages

• NORMAL: Service and communication messages

Application is required on the Honor platform. Application link.

Set the channelId for Xiaomi notification types. Application is required on the Xiaomi platform. See: Application link.

Set the vivo notification message classification. Valid values:

• 0: Operational messages (default)

• 1: System messages

Message grouping. Messages in the same group display only the latest one and the total count of messages received in that group in the notification bar. All messages are not displayed and cannot be expanded. Currently supported:

• Huawei vendor channel

• Honor vendor channel

• Proprietary channel: Android SDK 3.9.1 and earlier

Message grouping. Messages in the same group are displayed collapsed in the notification bar and can be expanded. Notifications from different groups are displayed separately. Currently supported:

• Proprietary channel: Android SDK 3.9.2 and later

Set notification extended properties. This property does not take effect when the push type PushType is set to MESSAGE.

This parameter must be passed in JSON map format; otherwise, parsing errors will occur.

Huawei channel notification delivery priority. Valid values:

• HIGH

• NORMAL

Permission application is required. See: Application link.

Purpose 1: After completing the self-classification privilege application, this is used to identify the message type, determine the notification alert method, and speed up delivery for specific message types. For valid values, refer to the Huawei Push official documentation's Message Classification Standard. Use the "Cloud notification category value" or "Local notification category value" from the documentation table.

Purpose 2: After applying for special permissions, this is used to identify high-priority pass-through scenarios. Valid values:

• VOIP: Audio/video calls

• PLAY_VOICE: Voice playback

OPPO classifies messages into two categories: Communication & Service, and Content & Marketing.

Communication & Service (permission application required):

• IM: Instant messaging, audio, and video calls

• ACCOUNT: Personal account and asset changes

• DEVICE_REMINDER: Personal device reminders

• ORDER: Personal order/logistics status changes

• TODO: Personal schedule/to-do items

• SUBSCRIPTION: Personal subscriptions

Content & Marketing:

• NEWS: News and information

• CONTENT: Content recommendations

• MARKETING: Platform promotions

• SOCIAL: Social updates

For details, see OPUSH Message Classification Rules

OPPO channel notification bar message alert level. Valid values:

• 1: Notification bar

• 2: Notification bar, lock screen, ringtone, and vibration (default notification level for Communication & Service messages)

• 16: Notification bar, lock screen, ringtone, vibration, and banner (permission application required)

vivo classifies messages into two categories: System messages and Operational messages.

System messages:

• IM: Instant messages

• ACCOUNT: Account and assets

• TODO: Schedule and to-do items

• DEVICE_REMINDER: Device information

• ORDER: Orders and logistics

• SUBSCRIPTION: Subscription reminders

Operational messages:

• NEWS: News

• CONTENT: Content recommendations

• MARKETING: Operational campaigns

• SOCIAL: Social updates

Set the vendor channel notification type:

• 0: Production notification (default).

• 1: Test notification.

Set the Huawei channel notification type:

• 0: Production notification (default).

• 1: Test notification.

Set the Honor channel notification type:

• 0: Production notification (default).

• 1: Test notification.

Set the vivo channel notification type:

• 0: Production push (default).

• 1: Test push.

Set the OPPO Fluid Cloud push environment:

• 0: Production environment (default).

• 1: Test environment.

Set the Huawei instant notification parameter:

• 0: Send a regular Huawei notification (default).

• 1: Send a Huawei instant notification.

Huawei channel receipt ID. This receipt ID can be found in the receipt parameter configuration on the Huawei channel push operations platform.

vivo channel receipt ID. This receipt ID can be found in the app information section of the push service on the vivo open platform.

Full class name of the app entry Activity for badge settings.

Set the badge increment value. The value is added to the existing badge count. Value range: [1-99].

Set the badge to a fixed number. Value range: [0-99].

Huawei vendor channel notification sound. Specify the name of an audio file stored in the client project's app/src/main/res/raw/ directory. The file extension is not required.

If not set, the default ringtone is used.

When the push type is message and the device is offline, this push will use the auxiliary popup feature. Defaults to false. Only takes effect when PushType=MESSAGE.

If the message-to-notification conversion push is successful, the notification displays the data set by the server's HarmonyRemindTitle and HarmonyRemindBody parameter values.

HarmonyOS notification title used when converting HarmonyOS messages to notifications. Only valid when HarmonyRemind is true.

HarmonyOS notification content used when converting HarmonyOS messages to notifications. Only valid when HarmonyRemind is true.

Notification message category. After completing the notification message self-classification privilege application, this is used to identify the message type. Different notification message types affect the display and alert methods. Valid values:

• IM: Instant messaging

• VOIP: Audio/video calls

• SUBSCRIPTION: Subscriptions

• TRAVEL: Travel

• HEALTH: Health

• WORK: Work task reminders

• ACCOUNT: Account updates

• EXPRESS: Orders & logistics

• FINANCE: Finance

• DEVICE_REMINDER: Device reminders

• MAIL: Email

• CUSTOMER_SERVICE: Customer service messages

• MARKETING: News, content recommendations, social updates, product promotions, financial updates, lifestyle information, surveys, feature recommendations, and operational campaigns (only marks the content, does not speed up message delivery), collectively referred to as information and marketing messages

For details, see HarmonyOS official documentation Notification.category

Use the specified type of notification slot. Only valid when the Alibaba Cloud proprietary channel is online.

• SOCIAL_COMMUNICATION: Social communication.

• SERVICE_INFORMATION: Service reminders.

• CONTENT_INFORMATION: Content information.

• CUSTOMER_SERVICE: Customer service messages. This type is used for customer service messages between users and merchants, and must be initiated by the user.

• OTHER_TYPES: Others.

For details, see HarmonyOS official documentation SlotType

Unique identifier for each message displayed in the notification. When not provided, the push service automatically generates a unique identifier for each message. Different notification messages can share the same notifyId, enabling new messages to replace old ones.

For details, see HarmonyOS official documentation Notification.notifyId

Action after clicking the notification. Valid values:

• APP_HOME_PAGE: Open the app home page

• APP_CUSTOM_PAGE: Open a custom app page

The action corresponding to the built-in page ability of the app.

For details, see HarmonyOS official documentation ClickAction.action

The URI corresponding to the built-in page ability of the app.

For details, see HarmonyOS official documentation ClickAction.uri

Notification message style:

• NORMAL: Standard notification (default)

• MULTI_LINE: Multi-line text style

URL for the large icon on the right side of the notification. The URL must use the HTTPS protocol.

For details, see HarmonyOS official documentation Notification.image

Content for multi-line text style. Required when HarmonyRenderStyle is MULTI_LINE. Up to 3 content items are supported.

Set notification extended properties. This property does not take effect when the push type PushType is set to MESSAGE.

This parameter must be passed in JSON map format; otherwise, parsing errors will occur.

Test message flag:

• false: Normal message (default)

• true: Test message

For details, see HarmonyOS official documentation pushOptions.testMessage

HarmonyOS channel receipt ID. This receipt ID can be found in the receipt parameter configuration on the HarmonyOS channel push operations platform.

For details, see HarmonyOS official documentation pushOptions.receiptId

When PushType is NOTICE, whether this is a HarmonyOS notification extension message.

• true: Send a notification extension message

• false: Send a regular notification (default)

Notification extension messages require permission to be applied for on the HarmonyOS side before sending. For details, see the HarmonyOS documentation Send Notification Extension Messages.
Supported from HarmonyOS SDK 1.2.0.

Extra data for notification extension messages.
Valid when sending HarmonyOS notification extension messages.
Conceptually equivalent to the extraData field of HarmonyOS notification extension messages. For the specific definition, see HarmonyOS ExtensionPayload Description.
Supported from HarmonyOS SDK 1.2.0.

HarmonyOS app badge increment number. See HarmonyOS badge addNum field description.
Supported from HarmonyOS SDK 1.2.0.

HarmonyOS app badge set number. See HarmonyOS badge setNum field description.
Supported from HarmonyOS SDK 1.2.0.

This parameter has been deprecated.

This parameter has been deprecated. All third-party auxiliary popups are now supported by the new parameter AndroidPopupTitle.

This parameter has been deprecated. All third-party auxiliary popups are now supported by the new parameter AndroidPopupBody.

This parameter has been deprecated. All third-party auxiliary popups are now supported by the new parameter AndroidPopupActivity.

Meizu message type

• 0: Public message (default)

• 1: Private message

OPPO private message template ID

Xiaomi private message template ID

Xiaomi private message template parameters, JSON string

JSON string of the HarmonyOS Live View data structure LiveViewPayload. For development integration, see HarmonyOS Live View Push Guide

JSON string of the Huawei Android Live Notification data structure LiveNotificationPayload. For development integration, see Huawei Live Notification Push Guide

JSON string of the OPPO Fluid Cloud intent sharing data structure IntelligentIntent. For development integration, see OPPO Fluid Cloud Push Guide

JSON string of the OPPO Fluid Cloud intent deletion data structure data. This parameter is ignored when the AndroidOppoIntelligentIntent parameter is already provided. For development integration, see OPPO Fluid Cloud Push Guide

JSON string of the vivo Atomic Island data structure liveMessage. For development integration, see vivo Atomic Island Push Guide

JSON string of the Xiaomi Super Island data structure miui.focus.param. For development integration, see Xiaomi Super Island Push Guide

JSON string of the Xiaomi Super Island images miui.focus.pic_xxx. For development integration, see Xiaomi Super Island Push Guide