|
Parameter |
Type |
Description |
Example |
|---|---|---|---|
|
object |
Push task object |
||
| Action |
string |
The push method. This is an optional parameter. The default value is Important
The
|
PUSH_IMMEDIATELY |
| Target |
object |
The target object for the message push. This parameter is optional when the |
|
| Type |
string |
The push target type. Important
The
|
DEVICE |
| Value |
string |
Set the push target based on Note
|
value |
| Platform |
string |
The platform type. This is an optional parameter. |
IOS |
| Message |
object |
The pass-through message data sent to the device. The total length cannot exceed 4,000 bytes. Note
Length calculation
|
|
| Title |
string |
The title of the message to send. |
title |
| Body |
string |
The content of the message to send. |
{"key": "value"} |
| Notification |
object |
The vendor notification data sent to the device. Important
If you set both
|
|
| Title |
string |
The title of the push notification. Note
The length limits are as follows:
|
您有一条新消息 |
| Body |
string |
The content of the push notification. Note
The length limits are as follows:
|
尊敬的客户,您好!您的预约订单已取消成功。 |
| Ios |
object |
iOS notification configuration |
|
| Subtitle |
string |
The subtitle of the iOS notification. |
请查收订单。 |
| Music |
string |
The iOS notification sound. Specify the name of the audio file stored in the app bundle or the sandbox Library/Sounds directory. For more information, see How to set the notification sound for iOS push. Note
|
default |
| Badge |
integer |
The iOS application badge. |
1 |
| BadgeAutoIncrement |
boolean |
Specifies whether to enable the badge auto-increment feature. This is an optional parameter. The default value is false. Note
|
false |
| Silent |
boolean |
Controls whether to enable silent push mode. Note
|
false |
| Mutable |
boolean |
Enables extended notifications and controls whether iOS notifications support processing by the Notification Service Extension. Note
|
true |
| Category |
string |
Specifies the category identifier for an iOS notification. This defines the notification's interactive behavior and display style. Note
|
MESSAGE_REPLY |
| CollapseId |
string |
A unique identifier that controls notification merging. Notifications with the same identifier are overwritten. |
order_status_update_12345 |
| ThreadId |
string |
The thread identifier for iOS notification grouping. It is used to classify and collapse related notifications. Note
|
news_category_tech |
| InterruptionLevel |
string |
The interruption level. This is an optional parameter. Valid values are:
|
active |
| RelevanceScore |
number |
The relevance score of the notification message. It is used to control the priority and display policy of the notification. |
0.5 |
| ExtParameters |
string |
Custom extension properties for iOS notifications. Note
|
{"attachment": "https://xxxx.xxx/notification_pic.png"} |
| LiveActivity |
object |
Live Activities parameter object. Important
|
|
| Id |
string |
The unique identifier for a Live Activity. It associates the activity instance on the device with the push target on the server. Important
|
FOOD_DELIVERY_ORD20231201001 |
| Event |
string |
Starts, updates, or ends a Live Activity. |
start |
| AttributesType |
string |
The type of Live Activity to start. Note
This is required when |
OrderActivityAttributes |
| Attributes |
string |
Static pass-through parameters for iOS Live Activities push. They are used to transmit immutable business identification information. Note
This is required when |
{ "orderId": "ORD20231201001", "restaurantName": "美味餐厅", "customerAddress": "xx区xx路xx号", "orderType": "delivery" } |
| ContentState |
string |
Dynamic pass-through parameters for a Live Activity. They contain real-time updatable status information and changing data. Note
|
{ "status": "delivering", "estimatedTime": "10分钟", "progress": 80, "driverName": "李师傅", "currentStep": "配送员正在路上"} } |
| DismissalDate |
integer |
Sets the retention period for a finished Live Activity on the lock screen. This lets users view information after the activity has ended. It is a Unix timestamp in seconds. |
1701439800 |
| StaleDate |
integer |
Sets the expiration timestamp for the content of an iOS Live Activity. It is a Unix timestamp in seconds. Note
|
1701425400 |
| ApnsEnv |
string |
iOS notifications are sent through the Apple Push Notification service (APNs) center. You must specify the environment information. This is an optional parameter. The default is the production environment.
|
DEV |
| Hmos |
object |
HarmonyOS notification configuration. |
|
| Category |
string |
The notification message category. This is an optional parameter. The default category is Note
After you apply for the right to self-classify notification messages, this parameter is used to identify the message type. Different notification message types affect how messages are displayed and how users are reminded. For more information, see Notification.category on the official HarmonyOS website. |
IM |
| SlotType |
string |
Uses the specified type of notification channel. Note
|
SOCIAL_COMMUNICATION |
| NotifyId |
integer |
Specifies the unique identifier (notifyId) for each message when it is displayed in the notification bar. If not provided, the push service automatically generates a unique identifier. Different notification messages can use the same notifyId to allow new messages to overwrite old ones. For more information, see Notification.notifyId on the official HarmonyOS website. |
123456 |
| Action |
string |
Specifies the action corresponding to the ability of an in-app page. Note
For more information, see ClickAction.action on the official HarmonyOS website. |
com.example.action |
| Uri |
string |
The URI corresponding to the ability of an in-app page. Note
|
https://www.example.com:8080/push/example |
| RenderStyle |
string |
The notification message style. This is an optional parameter. The default is a normal notification. |
NORMAL |
| ImageUrl |
string |
The URL for the large icon on the right side of the notification. The URL must use the HTTPS protocol. Note
|
https://example.com/xxx.png |
| InboxContent |
array |
When |
|
|
string |
Text. |
1. 您有一个事项待处理 |
|
| ExtParameters |
string |
Sets custom extension properties for the notification message. This is used to pass additional business data. Note
The parameter must be passed in a standard JSON Map format. An incorrect format causes parsing to fail. |
{"key": "value"} |
| TestMessage |
boolean |
Enables test messages. Note
|
true |
| ReceiptId |
string |
The receipt ID for the HarmonyOS channel. This ID can be found in the receipt parameter settings on the HarmonyOS channel push operations platform. Note
|
RCPB***DFD5 |
| ExtensionPush |
boolean |
Enables the HarmonyOS notification extension. Note
|
false |
| ExtensionExtraData |
string |
Extra data for the notification extension message. Note
|
text |
| BadgeSetNum |
integer |
The HarmonyOS application badge number setting. Note
|
1 |
| BadgeAddNum |
integer |
The HarmonyOS application badge cumulative number. Note
|
1 |
| LiveViewPayload |
string |
The JSON string of the HarmonyOS Live Window data structure LiveViewPayload. For developer integration, see the document HarmonyOS Live Window Push Guide. |
{ "activityId": 1, "operation": 0, "event": "TAXI", "status": "DRIVER_ON_THE_WAY", "activityData": { "notificationData": { "type": 3 } } } |
| Sound |
string |
The HarmonyOS custom ringtone file name. |
music.mp3 |
| SoundDuration |
integer |
The duration of the custom message notification ringtone in seconds. The range is [1, 60]. If the ringtone duration is too short, it will loop. |
2 |
| Android |
object |
Android notification configuration |
|
| VendorChannelActivity |
string |
Specifies the Activity to open after the notification is clicked. Warning You must fill in this option when you use an Android vendor channel. |
com.alibaba.cloudpushdemo.bizactivity |
| ChannelId |
string |
Sets the channelId for the Android app. It must correspond to the channelId in the vendor's app. Note
|
8.0up |
| RenderStyle |
string |
The notification style. Valid values are:
|
0 |
| PictureUrl |
string |
The image URL in large image mode. Currently supported by: proprietary channels with Android SDK 3.6.0 and later. |
https://imag.example.com/image.png |
| ImageUrl |
string |
The URL for the icon on the right. Currently supported by:
|
https://imag.example.com/image.png |
| InboxContent |
array |
The body text in Inbox mode. The content is a valid JSON Array with no more than 5 elements. Currently supported by:
|
|
|
string |
Body text |
1. 第一条待处理事项 |
|
| NotifyId |
integer |
The unique identifier for an Android notification bar message. It controls the overwriting and replacement behavior of notifications. A new notification with the same NotifyId automatically overwrites the old one. |
233856727 |
| GroupId |
string |
Message grouping. For messages in the same group, only the latest one and the total number of messages received in that group are displayed in the notification bar. Not all messages are displayed, and they cannot be expanded. Currently supported by:
Note
This parameter is no longer supported by proprietary channels in Android SDK 3.9.2 and later versions. |
group-1 |
| ExtParameters |
string |
Custom extension properties for Android notifications. Note
|
{"key1":"value1"} |
| Music |
string |
The Huawei vendor channel notification sound. Specify the name of the audio file stored in the |
alicloud_notification_sound |
| BadgeSetNum |
integer |
Sets a fixed value for the badge number. The value range is [1, 99]. Note
|
4 |
| BadgeAddNum |
integer |
Sets a cumulative value for the badge, which is added to the original badge number. Note
|
1 |
| BadgeActivity |
string |
The full class name of the application entry Activity for badge settings. Note
This is only valid when pushing through the Huawei or Honor vendor channel. |
com.alibaba.cloudpushdemo.bizactivity |
| TestMessage |
boolean |
Sets the vendor channel notification type:
Note
Currently supported by: Huawei channel, Honor channel, vivo channel, and OPPO Fluid Cloud. |
false |
| Options |
object |
Detailed channel configuration. |
|
| Accs |
object |
Alibaba Cloud proprietary configuration Note
This is only valid when using Alibaba Cloud's proprietary channel. |
|
| CustomStyle |
integer |
The custom Android notification bar style. The value can be from 1 to 100. Note
The client must complete the style preset configuration. For more information, see the Custom Notification Style API document. |
1 |
| Priority |
integer |
The priority of the Android notification's position in the notification bar. Valid values: -2, -1, 0, 1, 2. |
0 |
| ThreadId |
string |
Message grouping. Messages in the same group are displayed collapsed in the notification bar and can be expanded. Different groups of notifications are displayed separately. Note
This is for Android SDK 3.9.2 and later. |
order_ORD20231201001 |
| OpenType |
string |
The action to take after the notification is clicked. Valid values:
|
APPLICATION |
| OpenActivity |
string |
Sets the activity to open when the notification is clicked. This is valid when |
com.alibaba.cloudpushdemo.bizactivity |
| OpenUrl |
string |
After an Android device receives a push, clicking the notification opens the corresponding URL. This is valid when |
www.example.com |
| NotifyType |
string |
The notification reminder method. Valid values:
|
NONE |
| Huawei |
object |
Huawei configuration |
|
| ReceiptId |
string |
The receipt ID for the Huawei channel. This ID can be found in the receipt parameter settings on the Huawei channel push operations platform. Note
If the default receipt configuration on the Huawei channel push operations platform is the Alibaba Cloud receipt, you do not need to provide this. If not, we recommend that you first configure the default Huawei channel receipt ID in the Alibaba Cloud EMAS Mobile Push console. |
RCP4C123456 |
| Category |
string |
Function 1: After you apply for self-classification rights, this is used to identify the message type and determine the message reminder method. It speeds up the sending of specific types of messages. For valid values, see the message classification standards in the official Huawei Push documentation. Fill in the "Cloud notification category value" or "Local notification category value" from the document's table. Function 2: After applying for special permissions, this is used to identify high-priority pass-through scenarios. Valid values are:
Note
|
VOIP |
| Urgency |
string |
The Huawei channel notification delivery priority. Valid values are:
You must apply for permission. For more information, see: Application link. |
NORMAL |
| Importance |
integer |
Sets the importance parameter for Huawei notification message classification, which determines the notification behavior on the user's device. Valid values are:
Note
We recommend using |
0 |
| BusinessType |
integer |
Sets the Huawei quick notification parameters.
|
1 |
| LiveNotificationPayload |
string |
The JSON string of the Huawei Android Live Window data structure LiveNotificationPayload. For developer integration, see the document Huawei Live Window Push Guide. |
{ "activityId": 1, "operation": 1, "event": "TAXI", "activityData": { "notificationData": { "type": 3 } } } |
| Honor |
object |
Honor configuration |
|
| Importance |
integer |
Sets the importance parameter for Honor notification message classification, which determines the notification behavior on the user's device. Valid values are:
You must apply for this on the Honor platform. Application link. |
0 |
| Xiaomi |
object |
Xiaomi configuration |
|
| Channel |
string |
Sets the channelId for the Xiaomi notification type. You must apply for this on the Xiaomi platform. For more information, see: Application link. Note
A single application can apply for a maximum of 8 channels on the Xiaomi channel. Plan accordingly. |
michannel |
| FocusParam |
string |
The JSON string of the Xiaomi Super Island data structure miui.focus.param. For developer integration, see the document Xiaomi Super Island Push Guide. |
|
| FocusPics |
string |
The JSON string of the Xiaomi Super Island data image miui.focus.pic_xxx. For developer integration, see the document Xiaomi Super Island Push Guide. |
|
| Vivo |
object |
vivo configuration |
|
| Category |
string |
vivo classifies messages into two categories for management: system messages and operational messages. System messages:
Operational messages:
For more information, see vivo classification description. |
MARKETING |
| ReceiptId |
string |
The message receipt identifier for the vivo vendor push channel. It is used to receive push result callback notifications. Note
|
1232221 |
| Importance |
integer |
Sets the vivo notification message classification. Valid values are:
Note
We recommend using |
0 |
| LiveMessage |
string |
The JSON string of the vivo Atomic Island data structure liveMessage. For developer integration, see the document vivo Atomic Island Push Guide. |
{ "operation": 0, "scene": "HEALTH_REGISTER", "templateType": 1, "showNotify": true, "changeRecord": 999, "capsuleData": { "bgColor": "#32d4d4" } } |
| Oppo |
object |
OPPO configuration |
|
| Category |
string |
OPPO classifies messages into two categories for management: communication and services, and content and marketing. Communication and services (requires permission application):
Content and marketing:
For more information, see vivo classification description. |
NEWS |
| NotifyLevel |
integer |
The OPPO channel notification bar message reminder level. Valid values are:
Note
When you use the |
1 |
| PrivateMsgTemplateId |
string |
The OPPO private message template ID. |
687557242b1634hzefs3d5013 |
| PrivateTitleParameters |
string |
The OPPO private message template title parameters. |
{"name": "张三"} |
| PrivateContentParameters |
string |
The OPPO private message template content parameters. |
{ "key1": "value1", "key2": "value2" } |
| IntelligentIntent |
string |
The JSON string of the OPPO Fluid Cloud's intent sharing data structure IntelligentIntent. For developer integration, see the document OPPO Fluid Cloud Push Guide. |
{ "intentName": "Example.Progress", "identifier": "d71ebd3119877b12ecdb6c4fe96b068e", "timestamp": 1729485000989, "serviceId": { "launcher": "999800001", "fluidCloud": "999900001" }, "intentAction": { "actionStatus": 0 }, "intentEntity": { "entityName": "TAXI" } } |
| DeleteIntentData |
string |
The JSON string of the OPPO Fluid Cloud's intent deletion data structure data. This parameter is invalid if the AndroidOppoIntelligentIntent parameter is already filled. For developer integration, see the document OPPO Fluid Cloud Push Guide. |
{ "intentName": "Example.Progress", "entityIds": [ "A580202509130712" ], "serviceId": { "launcher": "999800001", "fluidCloud": "999900001" } } |
| Meizu |
object |
Meizu configuration |
|
| NoticeMsgType |
integer |
The Meizu message type.
|
0 |
| Options |
object |
Push options |
|
| UseChannels |
string |
Specifies the sending channel. Valid values are:
Note
|
accs,apns |
| PushTime |
string |
Specifies the sending time of the message, up to 7 days in the future. This is only valid when the Note
This uses the ISO 8601 standard and UTC time. The format is yyyy-MM-ddTHH:mm:ssZ. |
2025-06-19T12:00:00Z |
| ExpireTime |
string |
Sets the expiration time of the message. After this time, the message will no longer be sent. The maximum retention period is 72 hours. Note
Important For pass-through messages, if you do not set an expiration time, the message is only sent to online devices. If the device is offline, the message is discarded. |
2025-06-21T12:00:00Z |
| JobKey |
string |
A custom identifier for the push task. If JobKey is not empty, this field will be included in the receipt log. To view receipt logs, see Receipt logs. |
jobkey1727749697913 |
| Trim |
boolean |
Specifies whether to automatically truncate oversized titles and content. Note
This is only supported for vendor channels that have explicit limits on title and content length. It does not apply to channels like APNs, Huawei, and Honor, which do not limit title and content length but only the total request body size. |
false |
| Sms |
object |
Resends the message as a text message. Note
Currently, this is only supported for |
|
| TemplateName |
string |
The SMS template name. You can get this from the SMS template management interface. It is the name assigned by the system, not the name set by the developer. |
SMS_123456789 |
| SignName |
string |
The SMS signature. |
某某科技 |
| Params |
string |
Key-value pairs for the variables in the SMS template. |
key1=value1&key2=value2 |
| DelaySecs |
integer |
The delay time to trigger the text message, in seconds. This must be set if you use SMS filter interaction. We recommend setting it to 15 seconds or more, with a maximum of 3 days, to avoid duplicate text messages and pushes. Note
When you use SMS filter interaction, the ExpireTime parameter is invalid. The notification expiration time is calculated based on the DelaySecs parameter. The expiration time is the current time plus the DelaySecs time. |
150 |
| SendPolicy |
string |
The SMS sending policy. |
PUSH_NOT_RECEIVED |
| MessageId |
integer |
A unique ID used to identify the message. This is only valid when the |
1174754033128**** |
该文章对您有帮助吗?