Push

AppKey information.

Push type. Valid values:

• NOTICE: Notification. Notifications are delivered to devices through vendor channels such as APNs, Huawei, Xiaomi, and HarmonyOS, and are displayed directly in the device notification bar. When an Android device is online (app process is alive), the notification is preferentially delivered through the Alibaba Cloud proprietary channel, where the Push SDK constructs and displays the notification, providing better push performance and potentially saving vendor push message quotas in some scenarios.

• MESSAGE: Message. Messages are delivered through the Alibaba Cloud proprietary online channel. They are not displayed in the notification bar by default, but need to be received and processed by the app when the process is active, allowing the business to decide whether to trigger certain business behaviors. When the device is offline (app process is inactive), messages cannot be received in a timely manner. In this case, you can use the iOSRemind or AndroidRemind parameters below to convert messages to notifications when the device is offline; or set the StoreOffline parameter below so the push system saves the message when the device is offline and automatically delivers it when the device comes online.

Device type. Valid values:

• HARMONY: HarmonyOS device

• iOS: iOS device

• ANDROID: Android device

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

Push target. Valid values:

• DEVICE: Push by device.

• ACCOUNT: Push by account.

• ALIAS: Push by alias.

• TAG: Push by tag.

• ALL: Push to all devices (the interval between two full pushes of the same DeviceType must be at least 1 second).

• TBD: Initialize continuous push. The push target is specified by the subsequent ContinuouslyPush API.

Set based on the Target type. Multiple values are separated by commas. If the limit is exceeded, split into multiple pushes.

• Target=DEVICE: Values such as deviceid1,deviceid2 (up to 1000).

• Target=ACCOUNT: Values such as account1,account2 (up to 1000).

• Target=ALIAS: Values such as alias1,alias2 (up to 1000).

• Target=TAG: Supports single and multiple tags. For the format, see Tag Format.

• Target=ALL: Value is ALL (fixed parameter for full push).

• Target=TBD: Value is TBD (fixed parameter for continuous push).

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

If enabled, 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 go 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. Scheduled sending must be no later than 7 days from now.

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

Expiration time for offline messages/notifications, used in conjunction with StoreOffline. Expired messages will no longer be sent. Maximum retention is 72 hours. Default is 72 hours.

The time format follows the ISO8601 standard and must use UTC time, in the format YYYY-MM-DDThh:mm:ssZ. The expiration time must be greater than the current time or the scheduled send time plus 3 seconds (ExpireTime > PushTime + 3 seconds). The 3-second buffer accounts for network and system delay tolerance. It is recommended to set at least 1 minute for single push, and at least 10 minutes for full push or batch push.

Custom identifier for the push task. When JobKey is not empty, the receipt log will include this field. For viewing receipt logs, see Receipt Logs.

Title of the notification/message during push. Length limit: 200 bytes.

Required for Android and HarmonyOS push; optional for iOS notifications. If provided:

• iOS 10+: Displayed as the notification title.

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

Notification content/message content for Android and HarmonyOS push; iOS message/notification content. The push content size is limited. See Product Limits.

Whether to automatically truncate overly long titles and content.

iOS notifications are sent through the APNs center, and the corresponding environment information must be provided.

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

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

When the device is offline during message push (i.e., the persistent connection to the 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 iOS Push Notification Sound.

If set to an empty string (""), the notification will be silent; if not set, it defaults to the system alert sound.

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

Whether to enable badge auto-increment. Default is false.

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

Whether to enable iOS silent notification.

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

Specify the iOS notification Category (iOS 10+).

When a device receives messages with the same CollapseId, they will be merged into one. When the device is offline and consecutive messages with the same CollapseId are sent, only the latest one is displayed in the notification bar. iOS 10+ supports this parameter.

This attribute is used to group iOS remote notifications, identifying the group name 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 a sound.

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

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

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

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

Extension attributes for iOS notifications.

For 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 will fail.

Start, update, or end a Live Activity.

• Enum: start | update | end

The Live Activity ID reported from the device to the user's server. The unique identifier of the Live Activity.

The type of Live Activity to start.

JSON string, static parameters for Live Activity (Dynamic Island) push. Contains static user-defined information such as product IDs and order information.

Dynamic parameters for Live Activity (Dynamic Island) push, containing real-time update information such as price and inventory changes.

Timestamp in seconds. The ended Live Activity will remain on the lock screen until this specified time, with a maximum of 4 hours.

Timestamp in seconds. Marks 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 supplementary popup feature. Default is false. Only effective when PushType=MESSAGE.

If the message-to-notification push is successful, the notification displays the AndroidPopupTitle and AndroidPopupBody parameter values set on the server. The data obtained in the onSysNoticeOpened method of the supplementary popup when clicking the notification is the Title and Body parameter values set on the server.

Action after clicking the notification. Valid values:

• APPLICATION: Open the application (default)

• ACTIVITY: Open an Android Activity

• URL: Open a URL

• NONE: No redirect

Specify the activity to open from the notification.

Only pass this when AndroidOpenType="Activity", e.g.: com.alibaba.cloudpushdemo.bizactivity.

URL to open when Android receives the push.

Only pass this when AndroidOpenType="URL".

Specify the Activity to navigate to after clicking the notification.

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

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

If using vendor channels, it must also comply with vendor channel limits. For details, see: Android Supplementary Channel Push Limits.

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

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

If using vendor channels, it must also comply with vendor channel limits. For details, see: Android Supplementary 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 the 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 above.

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

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

Currently supported by:

• Huawei: EMUI 10 and above

• Honor: Magic UI 4.0 and above

• Xiaomi: MIUI 10 and above

• OPPO: ColorOS 5.0 and above

• Meizu: Flyme

• Proprietary channel: Android SDK 3.6.0 and above

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

This parameter is deprecated. Starting from August 2023, Xiaomi officially no longer supports dynamically setting small icons, right-side icons, and big pictures during push on new devices/systems.

Right-side icon URL. Currently supported by:

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

This parameter is deprecated. Starting from August 2023, Xiaomi officially no longer supports 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 by:

• Huawei: EMUI 9 and above

• Honor: Magic UI 4.0 and above

• Xiaomi: MIUI 10 and above

• OPPO: ColorOS 5.0 and above

• Proprietary channel: Android SDK 3.6.0 and above

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

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

Unique identifier for each message when 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, which must correspond to the channelId in the app.

• Set the NotificationChannel parameter. For specific usage, see FAQ: Notifications Not Received on Android 8.0+ Devices.

• Since the OPPO private message channel's channel_id is the same as the app's channelId, the channel_id for OPPO channel push takes this value.

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

Set the Huawei notification message classification importance parameter, which determines 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 notification behavior on user devices. Valid values:

• LOW: Information and marketing messages

• NORMAL: Service and communication messages

Requires application on the Honor platform. Application Link.

Set the Xiaomi notification type channelId. Requires application on the Xiaomi platform. For details, 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 are displayed as only the latest one in the notification bar along with the total count of messages received for that group. All messages are not shown and cannot be expanded. Currently supported by:

• Huawei vendor channel

• Honor vendor channel

• Proprietary channel: Android SDK 3.9.1 and below

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

• Proprietary channel: Android SDK 3.9.2 and above

Set the extension attributes of the notification. This attribute does not take effect when PushType is set to MESSAGE.

This parameter must be passed in JSON map format, otherwise parsing will fail.

Huawei channel notification delivery priority. Valid values:

• HIGH

• NORMAL

Requires permission application. For details, see: Application Link.

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

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

• VOIP: Audio/video calls

• PLAY_VOICE: Voice playback

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

Communication & Service (requires permission application):

• IM: Instant messaging, audio, video calls

• ACCOUNT: Personal account and asset changes

• DEVICE_REMINDER: Personal device reminders

• ORDER: Personal order/logistics status changes

• TODO: Personal schedules/to-dos

• SUBSCRIPTION: Personal subscriptions

Content & Marketing:

• NEWS: News and information

• CONTENT: Content recommendations

• MARKETING: Platform promotions

• SOCIAL: Social updates

For details, refer to OPUSH Message Classification Rules.

OPPO channel notification bar message notification level. Valid values:

• 1: Notification bar

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

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

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

• IM: Instant messages

• ACCOUNT: Accounts and assets

• TODO: Schedules and to-dos

• DEVICE_REMINDER: Device information

• ORDER: Orders and logistics

• SUBSCRIPTION: Subscription reminders

Operational messages:

• NEWS: News

• CONTENT: Content recommendations

• MARKETING: Operational promotions

• SOCIAL: Social updates

For details, refer to Classification Description.

Set vendor channel notification type:

• 0: Official notification (default).

• 1: Test notification.

Set Huawei channel notification type:

• 0: Official notification (default).

• 1: Test notification.

Set Honor channel notification type:

• 0: Official notification (default).

• 1: Test notification.

Set vivo channel notification type:

• 0: Official push (default).

• 1: Test push.

Set OPPO Fluid Cloud push environment:

• 0: Production environment (default).

• 1: Test environment.

Set Huawei Quick Notification parameter:

• 0: Send Huawei standard notification (default).

• 1: Send Huawei Quick Notification.

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

vivo channel receipt ID. This receipt ID can be found in the application information 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, which is added to the current badge count. Value range: [1-99].

Set a fixed badge 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, without the file extension.

If not set, the default ringtone is used.

When the push type is message and the device is offline, this push will use the supplementary popup feature. Default is false. Only effective when PushType=MESSAGE.

If the message-to-notification push is successful, the notification displays the HarmonyRemindTitle and HarmonyRemindBody parameter values set on the server.

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 rights application, this is used to identify the message type. Different notification message types affect how messages are displayed and how alerts are triggered. 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, operational promotions (only identifies content, does not accelerate message delivery), collectively referred to as information and marketing messages

For details, see the HarmonyOS official documentation Notification.category.

Use the specified notification channel type. Only effective 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: Other.

For details, see the HarmonyOS official documentation SlotType.

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

For details, see the HarmonyOS official documentation Notification.notifyId.

Action after clicking the notification. Valid values:

• APP_HOME_PAGE: Open app home page

• APP_CUSTOM_PAGE: Open app custom page

The action corresponding to the in-app page ability.

For details, see the HarmonyOS official documentation ClickAction.action.

The URI corresponding to the in-app page ability.

For details, see the 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 the HarmonyOS official documentation Notification.image.

Content for multi-line text style. Required when HarmonyRenderStyle is MULTI_LINE. Supports up to 3 items.

Set the extension attributes of the notification. This attribute does not take effect when PushType is set to MESSAGE.

This parameter must be passed in JSON map format, otherwise parsing will fail.

Test message flag:

• false: Official message (default)

• true: Test message

For details, see the 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 management platform.

For details, see the HarmonyOS official documentation pushOptions.receiptId.

When PushType is NOTICE, whether to send as a HarmonyOS notification extension message.

• true: Send notification extension message

• false: Send standard notification (default)

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

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

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

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

The template name for supplementary SMS. This can be obtained from the SMS template management page and is a system-assigned name, not a developer-defined name.

The signature for supplementary SMS.

Variable name-value pairs for the SMS template, in the format: key1=value1&key2=value2.

Delay time before triggering SMS, in seconds.

Must be set when using SMS convergence. Recommended to be 15 seconds or more, with a maximum of 3 days, to avoid duplication between SMS and push notifications.

Condition for triggering SMS. Valid values:

• 0: Triggered when push is not received.

• 1: Triggered when user has not opened the notification.

This parameter is deprecated.

This parameter is deprecated. All third-party supplementary popups are now supported by the new parameter AndroidPopupTitle.

This parameter is deprecated. All third-party supplementary popups are now supported by the new parameter AndroidPopupBody.

This parameter is deprecated. All third-party supplementary popups are now supported by the new parameter AndroidPopupActivity.

An idempotent parameter to prevent duplicate pushes caused by API client retries. When the same IdempotentToken is used for calls within 15 minutes, only one push will be made, and subsequent calls will return the result of the first successful push.

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, refer to the documentation HarmonyOS Live View Push Guide.

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

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

JSON string of the OPPO Fluid Cloud intent deletion data structure data. When the AndroidOppoIntelligentIntent parameter is already provided, this parameter is ignored. For development integration, refer to the documentation OPPO Fluid Cloud Push Guide.

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

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

JSON string of the Xiaomi Super Island image data miui.focus.pic_xxx. For development integration, refer to the documentation Xiaomi Super Island Push Guide.