PushTask

更新时间:
复制 MD 格式

Parameter

Type

Description

Example

object

Push task object

Action

string

Push method. Optional parameter, defaults to PUSH_IMMEDIATELY.

Important

The batch push API MassPushV2 only supports the following push methods:

  • PUSH_IMMEDIATELY

  • SCHEDULED_PUSH

PUSH_IMMEDIATELY

Target

object

Specifies the target of the message push. This parameter is optional when the Action is CREATE_CONTINUOUS_PUSH (create continuous push task).

Type

string

Push target type.

Important

The batch push API MassPushV2 and continuous push CONTINUOUS_PUSH only support the following three target types:

  • DEVICE

  • ACCOUNT

  • ALIAS

DEVICE

Value

string

Sets the push target based on Target.Type, with multiple targets separated by commas. The target types and values are described below:

Note
  • DEVICE: Device IDs, e.g., deviceid1,deviceid2, up to 1000.

  • ACCOUNT: Account IDs, e.g., account1,account2, up to 1000.

  • ALIAS: Aliases, e.g., alias1,alias2, up to 1000.

  • TAG: Supports single or multiple tags. See Tag format specification for the format.

  • ALL: Push to all devices. No value needs to be set. Pushing to all may increase costs, please use at your discretion.

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

  • Length is calculated based on the UTF-8 encoded byte length of the JSON serialized Message object string.

  • Chinese characters typically occupy 3 bytes in UTF-8 encoding.

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 Message and Notification are set, the device will only receive one, following these rules:

  • When the device is online, pass-through message data is sent;

  • When the device is offline, a system notification is sent;

Title

string

Title of the push notification.

Note

Length limits:

  • iOS/Harmony: byte length must not exceed 200

  • Android: character length must not exceed 50

您有一条新消息

Body

string

Content of the push notification.

Note

Length limits:

  • iOS/Harmony/Android: character length must not exceed 200

尊敬的客户,您好!您的预约订单已取消成功。

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
  • If you specify an empty string (""), the notification is silent.

  • If you do not set this parameter, the default value is 'default', which indicates the system's default sound.

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
  • This parameter cannot be used with the badge setting parameter.

  • The badge auto-increment feature is maintained by the Alibaba Cloud push server for each device. You must use an SDK of version 1.9.5 or later and actively sync the badge number to the server through the SDK.

false

Silent

boolean

Controls whether to enable silent push mode.

Note
  • When sending a silent notification, you can leave the title and body parameters empty.

false

Mutable

boolean

Enables extended notifications. This controls whether iOS notifications support processing by a Notification Service Extension.

Note
  • This must be set to true when sending a silent notification.

  • The extension processing time cannot exceed 30 seconds.

  • A timeout causes the original content of the notification to be displayed.

  • You need to add a Notification Service Extension to your application.

true

Category

string

Specifies the category identifier for the iOS notification. This defines the notification's interactive behaviors and display style.

Note
  • The category must be registered in the app beforehand to take effect.

  • Different categories can define different sets of actions.

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
  • Notifications with the same thread-id are automatically grouped.

  • Multiple related notifications are collapsed into a single notification group.

  • Users can expand the group to view all notifications within it.

news_category_tech

InterruptionLevel

string

The interruption level. This parameter is optional. The valid values are:

  • 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 presents the notification immediately, lights up the screen, and can play a sound, but it does not break through system notification controls.

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

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
  • The parameter must be passed in a standard JSON Map format. An incorrect format will cause parsing to fail.

{"attachment": "https://xxxx.xxx/notification_pic.png"}

LiveActivity

object

Live Activity parameter object.

Important
  • Live Activity pushes are supported only for single devices of the DEVICE type.

  • When pushing a Live Activity, you can leave the title and body parameters empty.

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
  • This ID must be consistent with the forActivityId parameter of the registerLiveActivityPushToken method in the client SDK.

  • The server uses this ID to locate the specific activity instance during a push.

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 Event is set to start.

OrderActivityAttributes

Attributes

string

Static pass-through parameters for iOS Live Activities pushes. These are used to transmit immutable business identification information.

Note

Required when Event is set to start.

{ "orderId": "ORD20231201001", "restaurantName": "美味餐厅", "customerAddress": "xxxxxx号", "orderType": "delivery" }

ContentState

string

Dynamic pass-through parameters for the Live Activity. These include real-time updatable status information and changing data.

Note
  • Avoid overly frequent updates (an interval of ≥5 seconds is recommended).

  • Update multiple fields in batches to reduce the number of pushes.

  • Consider the user experience to avoid screen flickering.

  • A valid JSON string.

{ "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
  • After the specified time is reached, the system automatically marks the activity as expired.

  • Expired activities are removed from the Live Activity and the lock screen.

  • This prevents outdated information from occupying the user interface for a long time.

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: The development environment, suitable for applications installed and debugged directly from Xcode.

  • PRODUCT: The production environment, suitable for applications distributed through the App Store, TestFlight, Ad Hoc, or enterprise distribution.

DEV

Hmos

object

HarmonyOS notification configuration.

Category

string

The category of the notification message. This parameter is optional. The default value is MARKETING.

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
  • This is valid only for the Alibaba Cloud proprietary channel.

  • For more information, see SlotType on the HarmonyOS official website.

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
  • If there are multiple abilities, specify the action and URI for each. The action is used first to find the corresponding in-app page.

  • For more information, see ClickAction.uri on the HarmonyOS official website.

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
  • Supported image formats are PNG, JPG, JPEG, HEIF, GIF, and BMP. The image resolution (length × width) must be less than 25,000 pixels.

  • For more information, see Notification.image on the HarmonyOS official website.

https://example.com/xxx.png

InboxContent

array

When RenderStyle is set to MULTI_LINE, you must fill in this field to define the content for the multi-line text style. A maximum of three content items are supported.

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
  • For more information, see the HarmonyOS push parameter TestMessage.

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
  • If the default receipt configuration on the HarmonyOS 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 HarmonyOS channel receipt ID in the Alibaba Cloud EMAS Mobile Push console.

  • For more information, see pushOptions.receiptId on the HarmonyOS official website.

RCPB***DFD5

ExtensionPush

boolean

Enables HarmonyOS notification extensions.

Note
  • You must apply for permission on the HarmonyOS official website before you can send notification extension messages. For more information, see the HarmonyOS document on sending notification extension messages.

  • Supported starting from HarmonyOS SDK version 1.2.0.

false

ExtensionExtraData

string

Extra data for the notification extension message.

Note
  • This is valid when sending HarmonyOS notification extension messages.

  • Conceptually, this is equivalent to the extraData field of a HarmonyOS notification extension message. For its definition, see the ExtensionPayload description in the HarmonyOS documentation.

  • Supported starting from HarmonyOS SDK version 1.2.0.

text

BadgeSetNum

integer

The number to set for the HarmonyOS application badge.

Note
  • For more information, see the description of the setNum field for HarmonyOS badges.

  • Supported starting from HarmonyOS SDK version 1.2.0.

1

BadgeAddNum

integer

The number to add to the HarmonyOS application badge.

Note
  • Supported starting from HarmonyOS SDK version 1.2.0.

  • For more information, see the description of the addNum field for HarmonyOS badges.

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
  • Because the channel_id for OPPO's private message channel is the same as the app's channelId, this value is used for the channel_id when pushing through the OPPO channel.

  • For pushes through Huawei, FCM, and Alibaba Cloud's proprietary channels, this value is used for the channel_id.

  • For specific uses, see the FAQ: Notifications are not received on devices with Android 8.0 or later.

8.0up

RenderStyle

string

The notification style. Valid values are:

  • 0: Standard mode (default)

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

  • 2: Large picture mode (supported by proprietary channels)

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

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:

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

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

  • Proprietary channel (Android SDK 3.5.0 and later).

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:

  • 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

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:

  • Huawei vendor channel

  • Honor vendor channel

  • Proprietary channel with Android SDK 3.9.1 and earlier

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
  • The parameter must be passed in a standard JSON Map format. An incorrect format will cause parsing to fail.

{"key1":"value1"}

Music

string

The notification sound for the Huawei vendor channel. Specify the name of the audio file stored in the app/src/main/res/raw/ directory of the client project, without the file format extension. If not set, the default ringtone is used.

alicloud_notification_sound

BadgeSetNum

integer

Sets a fixed value for the badge number. The value range is [1, 99].

Note
  • For vendor channel pushes, this is effective only for Huawei and Honor channels.

  • For pushes through Alibaba Cloud's proprietary channel, this is effective only on Huawei, Honor, and vivo models.

4

BadgeAddNum

integer

Sets the value to be added to the badge number. This value is added to the original badge number.

Note
  • Supported by Huawei and Honor channels.

  • If both BadgeAddNum and BadgeSetNum are present, the latter takes precedence.

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:

  • false: Formal notification (default).

  • true: Test notification.

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: Open the application (default).

  • ACTIVITY: Open the specified page OpenActivity.

  • URL: Open a URL.

  • NONE: No jump.

APPLICATION

OpenActivity

string

Sets the activity to open when the notification is clicked. This is valid when OpenType is set to ACTIVITY.

com.alibaba.cloudpushdemo.bizactivity

OpenUrl

string

The URL to open when the notification is clicked on an Android device. This is valid when OpenType is set to URL.

www.example.com

NotifyType

string

The notification reminder method. Valid values are:

  • VIBRATE: Vibrate (default).

  • SOUND: Sound.

  • BOTH: Sound and vibrate.

  • NONE: Silent.

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:

  • VOIP: Video call

  • PLAY_VOICE: Voice playback

Note
  • For "Cloud notification category value" that is "Not applicable", the Alibaba Cloud proprietary channel is used.

  • For "Local notification category value" that is "Not applicable", the Huawei channel is used.

VOIP

Urgency

string

The delivery priority for Huawei channel notifications. Valid values are:

  • HIGH

  • NORMAL

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:

  • 0: Marketing message

  • 1: Service and communication message

Note

We recommend using Category for notification classification. You need to apply on the Huawei platform. For more information, see: Application Link.

0

BusinessType

integer

Sets the Huawei Quick Notification parameter.

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

  • 1: Send a Huawei Quick Notification.

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:

  • 0: Marketing message

  • 1: Service and communication message

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:

  • IM: Instant messaging

  • ACCOUNT: Account and asset

  • TODO: To-do list

  • DEVICE_REMINDER: Device information

  • ORDER: Order and logistics

  • SUBSCRIPTION: Subscription reminder

Operational messages:

  • NEWS: News

  • CONTENT: Content recommendation

  • MARKETING: Operational activity

  • SOCIAL: Social dynamics

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
  • Location: Vivo Open Platform → Push Service → Application Information → Receipt Configuration.

  • Recommendation: First, configure the default receipt ID in the Alibaba Cloud EMAS console.

  • Condition for use: This configuration is required only if the default receipt on the Vivo platform is not the Alibaba Cloud receipt.

1232221

Importance

integer

Sets the vivo notification message classification. Valid values are:

  • 0: Operational message (default)

  • 1: System message

Note

We recommend using Category for notification classification. You need to apply on the vivo platform. For more information, see: Application Link.

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):

  • IM: Instant messaging

  • ACCOUNT: Account and asset

  • TODO: To-do list

  • DEVICE_REMINDER: Device information

  • ORDER: Order and logistics

  • SUBSCRIPTION: Subscription reminder

Content and marketing:

  • NEWS: News

  • CONTENT: Content recommendation

  • MARKETING: Operational activity

  • SOCIAL: Social dynamics

For more information, see vivo classification description.

NEWS

NotifyLevel

integer

The reminder level for OPPO channel notification bar messages. Valid values are:

  • 1: Notification bar

  • 2: Notification bar, lock screen, ringtone, vibration (default notification level for communication and service messages)

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

Note

When using the NotifyLevel parameter, you must also pass the Category parameter.

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 Public message (default)

  • 1 Private message

0

Options

object

Push options

UseChannels

string

Specifies the delivery channels. Values:

  • accs Alibaba Cloud proprietary channel

  • huawei Huawei channel

  • honor Honor channel

  • xiaomi Xiaomi channel

  • oppo OPPO channel

  • vivo vivo channel

  • meizu Meizu channel

  • fcm Google Firebase channel (HTTP v1 API)

  • apns APNs channel

  • harmony HarmonyOS channel

Note
  • If this parameter is not configured, all channels are available.

  • If configured, only the specified channels will be used.

  • If the configured channels conflict with the delivery strategy (e.g., iOS notification should only go through APNs channel, but this parameter does not include apns), delivery will not be performed.

accs,apns

PushTime

string

Specifies the message delivery time, up to 7 days in the future. Only effective when the Action parameter is SCHEDULED_PUSH.

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
  • Uses the ISO 8601 standard with UTC time, in the format YYYY-MM-DDThh:mm:ssZ.

  • The expiration time must satisfy: ExpireTime > PushTime + 3 seconds (3 seconds is the margin for network and system latency).

  • Recommendation: Set the expiration time to no less than 1 minute for single push, and no less than 10 minutes for full or batch push.

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 Android and HarmonyOS devices.

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 Action parameter is CONTINUOUS_PUSH.

1174754033128****