|
Parameter |
Type |
Description |
Example |
|---|---|---|---|
|
object |
Push task object |
||
| Action |
string |
Push method. Optional parameter, defaults to Important
The batch push API
|
PUSH_IMMEDIATELY |
| Target |
object |
Specifies the target of the message push. This parameter is optional when the |
|
| Type |
string |
Push target type. Important
The batch push API
|
DEVICE |
| Value |
string |
Sets the push target based on Note
|
value |
| Platform |
string |
Platform type. Optional parameter. |
IOS |
| Message |
object |
Pass-through message data sent to the device. Total length must not exceed 4000 bytes. Note
Length calculation notes
|
|
| Title |
string |
Title of the message to be sent. |
title |
| Body |
string |
Content of the message to be sent. |
{"key": "value"} |
| Notification |
object |
Vendor notification data sent to the device. Important
When both
|
|
| Title |
string |
Title of the push notification. Note
Length limits:
|
您有一条新消息 |
| Body |
string |
Content of the push notification. Note
Length limits:
|
尊敬的客户,您好!您的预约订单已取消成功。 |
| Ios |
object |
iOS notification configuration |
|
| Subtitle |
string |
The subtitle of the iOS notification. |
请查收订单。 |
| Music |
string |
The sound for the iOS notification. 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 notification sounds for iOS pushes. Note
|
default |
| Badge |
integer |
The badge number for the iOS application. |
1 |
| BadgeAutoIncrement |
boolean |
Specifies whether to enable the badge auto-increment feature. This parameter is optional. The default value is false. Note
|
false |
| Silent |
boolean |
Controls whether to enable silent push mode. Note
|
false |
| Mutable |
boolean |
Enables extended notifications. This controls whether iOS notifications support processing by a Notification Service Extension. Note
|
true |
| Category |
string |
Specifies the category identifier for the iOS notification. This defines the notification's interactive behaviors and display style. Note
|
MESSAGE_REPLY |
| CollapseId |
string |
A unique identifier used to control notification merging. Notifications with the same identifier will be overwritten. |
order_status_update_12345 |
| ThreadId |
string |
The thread identifier for grouping iOS notifications. This is used to categorize and collapse related notifications. Note
|
news_category_tech |
| InterruptionLevel |
string |
The interruption level. This parameter is optional. The valid values are:
|
active |
| RelevanceScore |
number |
The relevance score of the notification message. This is used to control the notification's priority and display policy. |
0.5 |
| ExtParameters |
string |
Custom extended properties for the iOS notification. Note
|
{"attachment": "https://xxxx.xxx/notification_pic.png"} |
| LiveActivity |
object |
Live Activity parameter object. Important
|
|
| Id |
string |
The unique identifier for the Live Activity. It is used to associate 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
Required when |
OrderActivityAttributes |
| Attributes |
string |
Static pass-through parameters for iOS Live Activities pushes. These are used to transmit immutable business identification information. Note
Required when |
{ "orderId": "ORD20231201001", "restaurantName": "美味餐厅", "customerAddress": "xx区xx路xx号", "orderType": "delivery" } |
| ContentState |
string |
Dynamic pass-through parameters for the Live Activity. These include real-time updatable status information and changing data. Note
|
{ "status": "delivering", "estimatedTime": "10分钟", "progress": 80, "driverName": "李师傅", "currentStep": "配送员正在路上"} } |
| DismissalDate |
integer |
Sets the retention period on the lock screen for a completed Live Activity. This allows users to view information after the activity has ended. The value is a UNIX timestamp in seconds. |
1701439800 |
| StaleDate |
integer |
Sets the expiration timestamp for the content of an iOS Live Activity. The value is a UNIX timestamp in seconds. Note
|
1701425400 |
| ApnsEnv |
string |
iOS notifications are sent through the Apple Push Notification service (APNs). You need to specify the corresponding environment information. This parameter is optional. The default value is the production environment.
|
DEV |
| Hmos |
object |
HarmonyOS notification configuration. |
|
| Category |
string |
The category of the notification message. This parameter is optional. The default value is Note
After you apply for and are granted the right to self-categorize notification messages, use this parameter 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 HarmonyOS official 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 overwrite old messages with new ones. For more information, see Notification.notifyId on the HarmonyOS official 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 HarmonyOS official 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 style of the notification message. This parameter is optional. The default is a normal notification. |
NORMAL |
| ImageUrl |
string |
The URL of 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 extended 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 will cause parsing to fail. |
{"key": "value"} |
| TestMessage |
boolean |
Enables test messages. Note
|
true |
| ReceiptId |
string |
The message receipt ID for the HarmonyOS channel. You can find this ID in the receipt parameter settings on the HarmonyOS channel push operations platform. Note
|
RCPB***DFD5 |
| ExtensionPush |
boolean |
Enables HarmonyOS notification extensions. Note
|
false |
| ExtensionExtraData |
string |
Extra data for the notification extension message. Note
|
text |
| BadgeSetNum |
integer |
The number to set for the HarmonyOS application badge. Note
|
1 |
| BadgeAddNum |
integer |
The number to add to the HarmonyOS application badge. Note
|
1 |
| LiveViewPayload |
string |
The JSON string of the HarmonyOS Live Window data structure LiveViewPayload. For development and integration, see HarmonyOS Live Window Push Guide. |
{ "activityId": 1, "operation": 0, "event": "TAXI", "status": "DRIVER_ON_THE_WAY", "activityData": { "notificationData": { "type": 3 } } } |
| Sound |
string |
The filename of the custom ringtone for HarmonyOS. |
music.mp3 |
| SoundDuration |
integer |
The duration of the custom notification ringtone, in seconds. The range is [1, 60]. If the ringtone duration is shorter than this value, it will loop. |
2 |
| Android |
object |
Android notification configuration |
|
| VendorChannelActivity |
string |
Specifies the Activity to jump to after the notification is clicked. Warning
This option must be filled in when using an Android vendor channel. |
com.alibaba.cloudpushdemo.bizactivity |
| ChannelId |
string |
Sets the channelId for the Android app. This 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 for the large picture mode. Currently supported by: proprietary channel with Android SDK 3.6.0 and later. |
https://imag.example.com/image.png |
| ImageUrl |
string |
The URL of the icon on the right. Currently supported by:
|
https://imag.example.com/image.png |
| InboxContent |
array |
The body content in Inbox mode. The content is a valid JSON Array with no more than 5 elements. Currently supported by:
|
|
|
string |
Body |
1. 第一条待处理事项 |
|
| NotifyId |
integer |
The unique identifier for an Android notification bar message. It is used to control the overwriting and replacement behavior of notifications. A new notification with the same NotifyId will automatically overwrite the old one. |
233856727 |
| GroupId |
string |
Message grouping. For messages in the same group, only the latest message and the total number of messages received in that group are displayed in the notification bar. All messages are not displayed and cannot be expanded. Currently supported by:
Note
This parameter is no longer supported by the proprietary channel in Android SDK 3.9.2 and later versions. |
group-1 |
| ExtParameters |
string |
Custom extended properties for the Android notification. Note
|
{"key1":"value1"} |
| Music |
string |
The notification sound for the Huawei vendor channel. 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 the value to be added to the badge number. This value is added to the original badge number. Note
|
1 |
| BadgeActivity |
string |
The fully qualified class name of the application's entry Activity for badge settings. Note
This is effective only for pushes through the Huawei or Honor vendor channels. |
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 settings. |
|
| Accs |
object |
Alibaba Cloud proprietary settings Note
This is effective only when using the Alibaba Cloud proprietary channel. |
|
| CustomStyle |
integer |
The custom notification bar style for Android. The value range is 1-100. Note
The client needs to complete the style preset configuration. For more information, see Custom Notification Style Interface. |
1 |
| Priority |
integer |
The priority for arranging Android notifications in the notification bar. Valid values are: -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. Notifications from different groups are displayed separately. Note
Android SDK 3.9.2 and later. |
order_ORD20231201001 |
| OpenType |
string |
The action to take after clicking the notification. Valid values are:
|
APPLICATION |
| OpenActivity |
string |
Sets the activity to open when the notification is clicked. This is valid when |
com.alibaba.cloudpushdemo.bizactivity |
| OpenUrl |
string |
The URL to open when the notification is clicked on an Android device. This is valid when |
www.example.com |
| NotifyType |
string |
The notification reminder method. Valid values are:
|
NONE |
| Huawei |
object |
Huawei settings |
|
| ReceiptId |
string |
The message receipt ID for the Huawei channel. You can find this ID 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 ID. 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 applying for the self-categorization right, this is used to identify the message type and determine the message reminder method. It accelerates 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 delivery priority for Huawei channel notifications. Valid values are:
You need to 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 parameter.
|
1 |
| LiveNotificationPayload |
string |
The JSON string of the Huawei Android Live Window data structure LiveNotificationPayload. For development and integration, see Huawei Live Window Push Guide. |
{ "activityId": 1, "operation": 1, "event": "TAXI", "activityData": { "notificationData": { "type": 3 } } } |
| Honor |
object |
Honor settings |
|
| 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 need to apply on the Honor platform. For more information, see: Application Link. |
0 |
| Xiaomi |
object |
Xiaomi settings |
|
| Channel |
string |
Sets the channelId for Xiaomi notification types. You need to apply 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 |
{ "param_v2": { "business": "taxi", "updatable": true, "orderId": "A580202509130712", "param_island": { "islandProperty": 1, "bigIslandArea": { "imageTextInfoLeft": { "type": 1 } } } } } |
|
| FocusPics |
string |
{ "miui.focus.pic_ticker": "https://example.com/ticker.jpg", "miui.focus.pic_aod": "https://example.com/aod.jpg", "miui.focus.pic_imageText": "https://example.com/imageText.jpg" } |
|
| TemplateId |
string |
小米私信模板 ID |
P10645 |
| TemplateParams |
string |
小米私信模板参数,JSON 字符串 |
{"keywords1":"Tom","keywords2":"phone"} |
| Vivo |
object |
VIVO settings |
|
| Category |
string |
vivo classifies and manages messages into two categories: 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, 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 development and integration, see vivo Atomic Island Push Guide. |
{ "operation": 0, "scene": "HEALTH_REGISTER", "templateType": 1, "showNotify": true, "changeRecord": 999, "capsuleData": { "bgColor": "#32d4d4" } } |
| Oppo |
object |
OPPO settings |
|
| Category |
string |
OPPO classifies and manages messages into two categories: communication and service, and content and marketing. Communication and service (requires permission application):
Content and marketing:
For more information, see vivo classification description. |
NEWS |
| NotifyLevel |
integer |
The reminder level for OPPO channel notification bar messages. Valid values are:
Note
When using the |
1 |
| PrivateMsgTemplateId |
string |
OPPO private message template ID |
687557242b1634hzefs3d5013 |
| PrivateTitleParameters |
string |
OPPO private message template title parameters |
{"name": "张三"} |
| PrivateContentParameters |
string |
OPPO private message template content parameters |
{ "key1": "value1", "key2": "value2" } |
| IntelligentIntent |
string |
The JSON string of the OPPO Fluid Cloud intent sharing data structure IntelligentIntent. For development and integration, see 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 intent deletion data structure data. This parameter is invalid if the AndroidOppoIntelligentIntent parameter is filled. For development and integration, see OPPO Fluid Cloud Push Guide. |
{ "intentName": "Example.Progress", "entityIds": [ "A580202509130712" ], "serviceId": { "launcher": "999800001", "fluidCloud": "999900001" } } |
| Meizu |
object |
Meizu settings |
|
| NoticeMsgType |
integer |
Meizu message type
|
0 |
| Options |
object |
Push options |
|
| UseChannels |
string |
Specifies the delivery channels. Values:
Note
|
accs,apns |
| PushTime |
string |
Specifies the message delivery time, up to 7 days in the future. Only effective when the Note
Uses the ISO 8601 standard with UTC time, in the format yyyy-MM-ddTHH:mm:ssZ. |
2025-06-19T12:00:00Z |
| ExpireTime |
string |
Sets the message expiration time. Messages will no longer be sent after expiration, with a maximum retention of 72 hours. Note
Important For pass-through messages, not setting an expiration time means only online delivery. When the device is offline, the message will be discarded. |
2025-06-21T12:00:00Z |
| JobKey |
string |
Custom identifier for the push task. When JobKey is not empty, the receipt log will include this field. See Receipt logs for viewing receipt logs. |
jobkey1727749697913 |
| Trim |
boolean |
Whether to automatically truncate titles and content that exceed length limits. Note
Only applicable to vendor channels that explicitly limit title and content length. Not applicable to APNs, Huawei, Honor channels, etc., which only limit the total request body size rather than title/content individually. |
false |
| Sms |
object |
Supplementary SMS delivery. Note
Currently only supports |
|
| TemplateName |
string |
The name of the SMS template. You can obtain this from the SMS template management interface. This is the system-assigned name, 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 for triggering 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 using 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 |
Unique ID used to identify the message. Only effective when the |
1174754033128**** |
该文章对您有帮助吗?