| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| testMessage | No | Boolean | Indicates whether a message is a test message. The options are as follows:
NOTE: When testMessage is set to true, a maximum of 1000 test messages can be pushed for a single project, and a maximum of 10 tokens can be carried in each push message. Only one token can be carried each time an authorized subscription message or widget update message is pushed. |
| ttl | No | Integer | Message cache duration, in seconds. When a user device is offline, the Push Kit server caches messages. If the user device goes online within the message cache duration, the messages are delivered. Otherwise, the messages are discarded. The default value is 86400 (1 day), and the maximum value is 1296000 (15 days). NOTE: When pushing an in-app call message or pushing a notification message or an extended notification message for a VoIP call, you are advised to set ttl to a duration within 30 to 60 seconds. |
| biTag | No | String | Tag of a message in a batch delivery task. The tag is returned to the app server when Push Kit sends the message receipt. The value contains a maximum of 64 bytes. |
| receiptId | No | String | Unique receipt ID that associates with the receipt URL and configuration of the downlink message. You can find the receipt ID in Setting Receipt Parameters. |
| collapseKey | No | Integer | Mode for the Push Kit server to cache messages sent to an offline device. These cached messages will be delivered once the device goes online again. The options are as follows:
For example, if you send 10 messages and set collapseKey to 1 for the first five messages and to 2 for the rest, the latest message whose value of collapseKey is 1 and the latest message whose value of collapseKey is 2 are sent to the user after the user's device goes online. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| token | Yes | Array [String] | Token used to push messages to target users. Example: {
"token": ["IQAAA*******"]
} NOTICE: Only one token can be carried each time a subscription message or widget update message is sent. In other scenarios, a maximum of 1000 tokens can be carried each time a message is sent. |
For details about the request body example, please refer to Notification Message.
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| notification | Yes | Notification Object | Notification message structure. For details, please refer to Notification. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| category | Yes | String | Notification message type. To use this parameter, you need to apply for the message self-classification permission by referring to Message Self-Classification. The notification message type affects the message display and notification modes. The options are as follows:
NOTE:
|
| title | Yes | String | Notification message title. (Note the message body size limits. For details, please refer to Restrictions.) |
| body | Yes | String | Notification message content. (Note the message body size limits. For details, please refer to Restrictions.) |
| image | No | String | URL of the large icon on the right of a notification. The URL must use the HTTPS protocol. NOTE: The supported image formats are PNG, JPG, JPEG, and BMP. It is recommended that the image width x height be less than 128 x 128 pixels. Images larger than 49,152 pixels will not be displayed. |
| style | No | Integer | Style of a notification message. The options are as follows:
NOTICE: The large text style (style=1) will be discarded. You are advised to use the common notification style (style=0). |
| bigTitle | No | String | Title of a notification in the large text style. This parameter is mandatory when style is set to 1. After bigTitle is specified, the value of bigTitle instead of that of title will be displayed in the notification panel. (Note the message body size limits. For details, please refer to Restrictions.) NOTICE: This parameter will be discarded. You are advised to use the title parameter. |
| bigBody | No | String | Content of a notification in the large text style. This parameter is mandatory when style is set to 1. After bigBody is specified, the value of bigBody instead of that of body will be displayed in the notification panel. (Note the message body size limits. For details, please refer to Restrictions.) NOTICE: This parameter will be discarded. You are advised to use the body parameter. |
| notifyId | No | Integer | Unique notification ID of a message. If a message does not contain the ID or the ID is -1, Push Kit will generate a unique ID for the message. Different notification messages can use the same notification ID, so that new messages can overwrite old messages. This parameter is mandatory if the message may need to be recalled later, and the value range is [0, 2147483647]. For details, please refer to Message Recall. |
| appMessageId | No | String | Unique ID of an app message. If a message does not contain the ID, no value will be assigned to appMessageId by default. When multiple app messages with the same appMessageId value are received through multiple channels (Push Kit, Near Field Communications, app-initiated data fetch from the cloud, or local notification sending), the target device displays only the earliest message within the validity period (different from notifyId, which is used as the basis for overwriting old messages with new messages). Specifically, if the values of notifyId and appMessageId are the same, the earliest message is displayed within the validity period (default: 24 hours). The value is a string of 1–64 characters, including uppercase letters, lowercase letters, digits, spaces, and the following special characters: + / = - _ |
| profileId | No | String | Anonymous identifier of an account in the app's account system. The value contains a maximum of 64 characters. |
| inboxContent | No | Array [String] | Content of a notification in the multi-line text style. This parameter is mandatory when style is set to 3. A message supports a maximum of three lines of text, and each line can contain up to 1024 characters, with an ellipsis (...) indicating truncated content. Example: {
"data": {
"key1": "value1",
"key2": "value2"
}
} |
| clickAction | Yes | ClickAction Object | Action to be triggered upon message tapping. For details, please refer to ClickAction. |
| badge | No | Badge Object | Badge of a notification message. For details, please refer to Badge. If this parameter is not set, the app will not display the badge if no badge exists before, and the badge number remains unchanged if a badge exists. Example: {
"badge": { "addNum": 1 }
} |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| actionType | Yes | Integer | Action to be triggered upon message tapping. The options are as follows: 0: open the app home page 1: open a custom app page 3: delete a notification message 5: open the dialer screen The value of actionType varies depending on the scenario. For details, please refer to Actions Upon Message Tapping in Different Scenarios. |
| action | No | String | Action corresponding to the ability of an in-app page. When actionType is set to 1, either uri or action must be set. For details about how to set action, please refer to Opening an In-app Page and Transferring Data upon Message Tapping. |
| uri | No | String | URI corresponding to the ability of an in-app page. For details about the internal structure of a uri object, please refer to skills. When actionType is set to 1, either uri or action must be set. If there are multiple abilities, set action or uri for each ability. The action parameter is preferentially used to search for the corresponding in-app page. For details about how to set uri, please refer to Opening an In-app Page and Transferring Data upon Message Tapping. |
| data | No | Object | Data transferred to an app upon message tapping. The value is a JSON object. (Note the message body size limits. For details, please refer to Restrictions.) When actionType is set to 5, data is mandatory. The value is in {"tel": "xxx"} format, where xxx is a phone number which contains a maximum of 20 characters, including the following:
Example: {
"data": {
"key1": "value1",
"key2": "value2"
}
} NOTICE: When actionType is set to 5, the first character must be the plus sign (+) or a digit ranging from 0 to 9. |
| push-type | Parameter | Enumerated Value of actionType |
|---|---|---|
| 0 (alert message) | notification.clickAction | 0: open the app home page 1: open a custom app page |
| subscription.clickAction | 0: open the app home page 1: open a custom app page | |
| 2 (extended notification message) | notification.clickAction | 0: open the app home page 1: open a custom app page |
| 7 (live view) | notificationData.clickAction | 0: open the app home page 1: open a custom app page |
| notificationData.extend.clickAction | 0: open the app home page 1: open a custom app page 3: delete a notification message 5: open the dialer screen NOTICE: If a device does not support the dialer function, no live view can be created even if actionType is set to 5. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| addNum | No | Integer | Increment to the badge number, which is an integer ranging from 1 to 99. NOTE:
|
| setNum | No | Integer | Badge number, which is an integer ranging from 0 to 99. This is the actual number displayed in the app badge. NOTE: The priority of setNum is higher than that of addNum.
|
For details about the request body example, please refer to Authorized Subscription Message.
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| subscription | Yes | Subscription Object | Subscription message content. For details, please refer to Subscription. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| entityId | Yes | String | Template instance ID corresponding to a subscription message. For details, please refer to Viewing Template Details. |
| data | No | Object | If the subscription message template contains placeholders, pass values in this parameter to replace placeholders in the template. Otherwise, leave this parameter empty. The passed content for each placeholder is a key-value pair, where the value contains a maximum of 50 characters. Example: {
"data": {
"key1": "value1",
"key2": "value2"
}
} |
| clickAction | Yes | ClickAction Object | Action to be triggered upon message tapping. For details, please refer to ClickAction. |
| profileId | No | String | Anonymous identifier of an account in the app's account system. The value contains a maximum of 64 characters. |
For details about the request body example, please refer to Extended Notification Message.
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| notification | Yes | Notification Object | Notification message structure. For details, please refer to Notification. NOTICE: The notification.category parameter is mandatory and must be set to EXPRESS. Before sending an extended notification message, apply for the corresponding message self-classification permission by referring to Message Self-Classification. In addition, you need to apply for the extended notification message permission. |
| extraData | Yes | String | Extra data of an extended notification message. (Note the message body size limits. For details, please refer to Restrictions.) |
For details about the request body example, please refer to Widget Update Message.
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| formId | Yes | Long | Instance ID of a service widget, which is obtained when onAddForm is called (a user adds the widget to the home screen). Note that the maximum value of formId generated by a device is 2^31-1, and the maximum value of formId you can set is 2^63-1. |
| version | Yes | Integer | Version number of a widget update message. The value ranges from 0 to 2^31-1.
|
| images | No | Array [FormImage Object] | Image data of a service widget, which is an array of objects. For details, please refer to FormImage. Currently, the array can contain only one object. Example: {
"images": [{
"keyName": "icon",
"url": "https://xxx.png",
"require": 1
}]
} |
| moduleName | Yes | String | Module name of a service widget. Value of name in the module section in src/main/module.json5 at the module level. |
| formName | Yes | String | Name of a service widget. The data comes from the value of name in the configuration of a widget under the forms section in the widget configuration file in src/main/resources/base/profile at the module level. For details, please refer to the guide. |
| abilityName | Yes | String | Ability name of a service widget. Ability name of the service widget in the extensionAbilities section in src/main/module.json5 at the module level. |
| formData | Yes | Object | Service data of the service widget to be updated, in key-value format. Example: {
"formData": {
"content": "newContent"
}
} The data comes from the declarative paradigm component name in the widget page file in src/main/ets/widgets at the module level. For details, please refer to the guide. NOTICE:
|
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| keyName | No | String | Image key. The value must be different from the key of the custom variable data in formData. The data comes from the image component name in the widget page file in src/main/ets/widgets at the module level. For details, please refer to the guide. |
| url | No | String | Image download URL. The URL must use the HTTPS protocol. NOTICE: The supported image formats are PNG, JPG, and JPEG. The image size cannot exceed 512 KB. The image width x height must be less than 12,800 pixels. |
| require | No | Integer | Image-based widget update policy. The options are as follows:
|
For details about the request body example, please refer to Background Message.
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| extraData | Yes | String | Data transferred to an app. (Note the message body size limits. For details, please refer to Restrictions.) Push Kit checks whether the app is in the foreground. If so, Push Kit transfers the data to the target app. If not, Push Kit caches the data or silently writes the data to the app cache. |
| proxyData | No | String | Indicates whether to use the data proxy to silently write data to the app cache when the process is not in the foreground. To use the data proxy, you must pass ENABLE. If you do not want to enable the proxy to write data, do not set this parameter in the message body. |
For details about the live view request example, please refer to Live View Creation Message and Live View Update Message.
To ensure the timeliness of live view messages, be sure to update the live view content promptly. If a live view is not updated for more than 2 hours, the system will hide the live view display on the status bar and lock screen, but retain its display in the notification panel. If a live view is not updated for more than 4 hours, the system considers that the live view ends and clears the live view from all display entrances.
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| activityId | Yes | Integer | Unique ID of a live view, which is generated by you. The value range is [-2147483648, 2147483647]. This parameter corresponds to the id parameter in Live View Kit. NOTICE: If the live view corresponding to a specific activityId does not exist in the scenario of updating or ending a live view, the use of this activityId to send live view messages will be banned for 24 hours. |
| operation | Yes | Integer | Live view message operation type. The options are as follows:
If optional parameters are not set, do not have default values, and are not otherwise specified during live view update or ending, their previously set values are inherited by default. |
| event | Yes | String | Service scenario. The options are as follows:
You need to apply for the permission on the corresponding scenario. For details, please refer to Application Filling Requirements for Live View Kit. NOTICE: For a live view creation message (operation is set to 0), the value of event must be FLIGHT, TAXI, or TRAIN. |
| status | No | String | Status of a live view message. This parameter is mandatory when operation is set to 0 or 1 and the live view to be updated is created through the REST API. The value range of status depends on the scenario. For details, please refer to Status Value Range. For details about how to use the placeholder {{status}} in the message body, please refer to Parameters That Support Placeholders. If the requirements are met, the placeholder in the parameter will be replaced with the target value. |
| title | No | String | (Optional) Title displayed in the notification panel when the system does not support live view notifications. |
| content | No | String | (Optional) Content displayed in the notification panel when the system does not support live view notifications. |
| mute | No | Boolean | Indicates whether to use silent reminder for message update. The options are as follows:
|
| version | No | Integer | Version number of a live view update notification, which is greater than or equal to 0. The version number of the live view update notification must be greater than that of the current live view notification. Otherwise, the update fails. |
| activityData | Yes | ActivityData Object | Detailed data of a live view notification. For details, please refer to ActivityData. |
For details about the sample request for creating a live view, please refer to Live View Creation Message.
| Event | Supported Layout During Creation | Mandatory Parameters During Creation | Mandatory Parameters for Update of a Live View Created Through the REST API |
|---|---|---|---|
| FLIGHT | Left-right text template | activityData.notificationData.keywords | |
| TAXI | Progress visualization Emphasized text template Left-right text template Live scores | ||
| TRAIN | Left-right text template | activityData.notificationData.keywords |
| Layout | Parameter |
|---|---|
| Progress visualization Live scores | activityData.notificationData.contentTitle activityData.notificationData.contentText.text |
| Emphasized text template | activityData.notificationData.contentTitle activityData.notificationData.contentText.text activityData.notificationData.extend.text activityData.notificationData.singleTextBlock.firstLine activityData.notificationData.singleTextBlock.secondLine |
| Left-right text template | activityData.notificationData.contentTitle activityData.notificationData.contentText.text activityData.notificationData.extend.text activityData.notificationData.firstTextBlock.firstLine activityData.notificationData.firstTextBlock.secondLine activityData.notificationData.lastTextBlock.firstLine activityData.notificationData.lastTextBlock.secondLine |
| Event | Value of status | Content to Replace the {{status}} Placeholder in the Message Body | Description |
|---|---|---|---|
| FLIGHT | DEPART | Scheduled departure | A reminder will be sent a certain time prior to the scheduled flight departure. |
| WAITING_FOR_CHECK_IN | Not checked in | The user has not checked in for the flight. | |
| CHECKED_IN | Checked in | The user has checked in for the flight. | |
| PASSED_SECURITY_CHECK | Security check completed | The user has completed security check. | |
| START_BOARDING | Boarding started | Boarding has started for the flight. | |
| URGE_BOARDING | Last boarding call | This is the last boarding call for the flight. | |
| BOARDED | Aboard | The user is aboard the plane. | |
| END_BOARDING | Boarding finished | The flight has finished boarding. | |
| ABOUT_TO_TAKE_OFF | About to take off | The flight is about to take off. | |
| TAKEN_OFF | Taken off | Users who have followed a flight are notified that the flight has taken off. | |
| ARRIVED | Arrived | The flight has arrived. | |
| TRANSFER | Connecting flight reminder | Reminder to notify the user of the next flight's information upon arrival at their transfer airport. You are advised to create a new live view for a different flight. | |
| NEW_ITINERARY | Next flight started | Reminder to notify the user that the next flight has started. | |
| GATE_CHANGE | Boarding gate change | The boarding gate has changed. | |
| FLIGHT_DELAY | Delay | The flight is delayed. | |
| FLIGHT_CANCEL | Cancellation | The flight is canceled. | |
| FLIGHT_DIVERSION | Diversion | The flight is diverted to another airport. | |
| FLIGHT_RETURN | Return | The flight has returned. | |
| TAXI | CALLING | Searching for a driver | The system is searching for a driver. |
| ABOUT_TO_BEGIN | Ride about to start | The ride is about to start. This status is used in scheduled ride-hailing and hitchhiking scenarios to remind the user a certain time before the ride starts. | |
| DRIVER_ON_THE_WAY | Driver on the way | The driver is on the way. | |
| DRIVER_ARRIVE | Driver arrived | The driver has arrived at the pickup point. | |
| HEADING_TO_DESTINATION | Heading to the destination | The vehicle is heading to the destination. If an order has multiple waypoints, this status can be used continuously until the trip is completed. | |
| COMPLETED | Trip completed | The trip is completed. | |
| RE_CALLING | Searching for a new driver | The system is searching for a new driver. This status is used when the order is reassigned or the driver cancels the order. | |
| CANCELED | Order canceled | The order is canceled. Orders canceled by users or due to insufficient driver availability in the area are both categorized as canceled orders. | |
| TRAIN | DEPART | Scheduled departure | A reminder will be sent to the user a certain period of time before the scheduled train departure. |
| PASSED_SECURITY_CHECK | Security check completed | The user has completed security check. | |
| TICKET_CHECK | Boarding reminder | The train has started boarding. | |
| CHECKED | Boarding completed | The user is aboard the train. | |
| CHECK_IN_CLOSED | Boarding finished | The train has finished boarding. | |
| SET_OFF | Departed | The train has departed. | |
| HEADING_TO_DESTINATION | Train on the move | As the train is moving, the system can provide real-time updates on the upcoming stations and how long it will take to get there. | |
| ARRIVED | Arrived | The train has arrived at the destination. | |
| GATE_CHANGE | Boarding gate change | The boarding gate has changed. | |
| TRAIN_DELAY | Train delayed | The train is delayed. | |
| TRAIN_CANCEL | Train canceled | The train is canceled. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| notificationData | Yes | NotificationData Object | Notification layout data. For details, please refer to NotificationData. |
| capsuleData | No | CapsuleData Object | Capsule layout data. For details, please refer to CapsuleData. |
| externalData | No | ExternalData Object | Data displayed on small cover screens of phones such as Pocket series. For details, please refer to ExternalData. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| type | Yes | Integer | Layout type. The options are as follows:
NOTICE: When you create a live view, each event can only use a specific layout type. For details, please refer to Restrictions on Live View Creation. When you update a live view, each event can use any layout type. |
| keywords | No | Map<String, String> | Live view keywords. This parameter is mandatory when operation is set to 0 and event is set to one of the following values:
For details about how to use placeholders in the message body, please refer to Parameters That Support Placeholders. |
| additionalText | No | String | Prompt information or disclaimer. This parameter is available only when NotificationData.type is set to 5. |
| keepTime | No | Long | Duration for storing live view notifications in the notification panel after a live view ends. The default value is 0, indicating that the notifications are not stored. The maximum value is 3600, in seconds. The storage period is subject to the value of this parameter carried in the live view ending message. The live view cannot be updated or ended again during the storage period. |
| contentTitle | No | String | Notification title. The value contains a maximum of 1024 characters. When operation is set to 0, this parameter is mandatory and cannot be an empty string. |
| contentText | No | Array [RichText Object] | Notification content, which consists of multiple rich text sections. The total text length cannot exceed 1024 characters. If you set the text color, only one color can be specified. When operation is set to 0, this parameter is mandatory and cannot be an empty string. |
| richProgress | No | RichProgress Object | Rich progress information. This parameter is mandatory when type is set to 3. For details, please refer to RichProgress. |
| singleTextBlock | No | SingleTextBlock Object | Text block to be emphasized in the emphasized text template style. This parameter is mandatory when type is set to 4. The text block occupies the left part of an extension area by default. For details, please refer to SingleTextBlock. |
| firstTextBlock | No | FirstTextBlock Object | Left text block in the multi-text-block layout. This parameter is mandatory when type is set to 5. For details, please refer to FirstTextBlock. |
| lastTextBlock | No | LastTextBlock Object | Right text block in the multi-text-block layout. This parameter is mandatory when type is set to 5. For details, please refer to LastTextBlock. |
| displayHorizontalLine | No | Boolean | Indicates whether to display the dividing line of an extension area. If this parameter is not set, the dividing line is displayed by default. The options are as follows:
NOTE: The dividing line is displayed only when type is set to 5 or 7. |
| spaceIcon | No | String | Spacing icon, which is a local resource. When type is set to 5, the icon occupies the middle of an extension area. When operation is set to 0 and type is set to 5, this parameter is mandatory and cannot be an empty string. The value is a file name in the specified path. Example: For the icon file icon.png stored in /resources/rawfile of the app, the value is icon.png. |
| extend | No | Extend Object | Style of an auxiliary area. This parameter is optional when there is no update. For details, please refer to Extend. NOTE:
|
| game | No | Game Object | Extension area of live scores. This parameter is mandatory when type is set to 7. For details, please refer to Game. |
| descPic | No | String | Description image in an extension area, which is not displayed by default. When type is set to 4 and the parameter is set, the image will occupy the right part of the extension area. If this parameter is not specified, the system uses the last updated image. When operation is set to 0 and type is set to 4, this parameter is mandatory and cannot be an empty string. The value is a file name in the specified path. Example: For the icon file icon.png stored in /resources/rawfile of the app, the value is icon.png. |
| clickAction | Yes | ClickAction Object | Action to be triggered upon message tapping. For details, please refer to ClickAction. |
| lockScreen | No | LiveViewLockScreen Object | Parameters related to the lock screen immersive live view. For details, please refer to LiveViewLockScreen. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| type | No | Integer | Display type of an auxiliary area. The options are as follows:
|
| text | No | String | Text information in an auxiliary area. When type is set to 1 or 2, this parameter is mandatory and cannot be an empty string. |
| pic | No | String | Image information in an auxiliary area. When type is set to 3 or 4, this parameter is mandatory and cannot be an empty string. The value is a file name in the specified path. Example: For the icon file icon.png stored in /resources/rawfile of the app, the value is icon.png. CAUTION: This parameter will no longer be maintained in the near future. Please switch to the image parameter promptly. |
| image | No | String | Image information in an auxiliary area. When type is set to 3 or 4, this parameter is mandatory and cannot be an empty string. The value is a file name in the specified path. Example: For the icon file icon.png stored in /resources/rawfile of the app, the value is icon.png. |
| clickAction | No | ClickAction Object | Action to be triggered upon auxiliary area tapping. For details, please refer to ClickAction. If this parameter is not specified, the auxiliary area does not support redirection. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| host | Yes | Team Object | Left style of an extension area. For details, please refer to Team. |
| guest | Yes | Team Object | Right style of an extension area. For details, please refer to Team. |
| competition | Yes | Competition Object | Middle style of an extension area. For details, please refer to Competition. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| icon | No | String | Team icon in the display area. When operation is set to 0, this parameter is mandatory and cannot be an empty string. The value is a file name in the specified path. Example: For the icon file icon.png stored in /resources/rawfile of the app, the value is icon.png. |
| name | No | String | Team name. When operation is set to 0, this parameter is mandatory and cannot be an empty string. |
| score | No | String | Live score. When operation is set to 0, this parameter is mandatory and cannot be an empty string. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| desc | No | String | Description text in the upper-middle part of an extension area. When operation is set to 0, this parameter is mandatory and cannot be an empty string. |
| time | No | String | Competition time in the lower-middle part of an extension area. When operation is set to 0, this parameter is mandatory and cannot be an empty string. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| picture | No | String | Image displayed in a lock screen immersive live view. The value is a file name in the specified path. Example: For the icon file icon.png stored in /resources/rawfile of the app, the value is icon.png. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| type | Yes | Integer | Capsule layout type. The options are as follows:
|
| status | Yes | Integer | Display status of a live view capsule on the status bar. The options are as follows:
|
| icon | Yes | String | Status icon, which is a local resource. You are advised to use an 18 x 18 vp solid-color vector icon. Example: For the icon file icon.svg stored in /resources/rawfile of the app, the value is icon.svg. |
| bgColor | Yes | String | Background color of a capsule. The value is in #ARGB format, with a number sign (#) and 8 hexadecimal digits. The following colors are not supported:
|
| remind | No | String | Dynamic effect of a capsule on the status bar. If this parameter is not specified, there is no special effect by default.
|
| title | No | String | Main text of the capsule. The value contains a maximum of 128 characters. This parameter is mandatory when operation is set to 0 and type is set to 1. When type is set to 1, this parameter specifies the capsule title. |
| content | No | String | Content of the capsule status. The value contains a maximum of 128 characters. The extended text specified by this parameter is displayed when a device uses the widescreen or is in landscape orientation. This parameter is mandatory when operation is set to 0 and type is set to 1 or 2. When type is set to 1 or 2, this parameter specifies the capsule content. |
| capsuleTimer | No | CapsuleTimer Object | Capsule timer. For details, please refer to CapsuleTimer. When type is set to 2, this parameter is mandatory and specifies the capsule timer information. |
| progress | No | Progress Object | Progress information in a capsule. For details, please refer to Progress. When type is set to 3, this parameter is mandatory and specifies the progress information in a capsule. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| max | No | Integer | Maximum progress value. The default value is 1. The value range is [1, 2147483647]. |
| progress | Yes | Integer | Current progress value. The value range is [0, 2147483647]. The value of this parameter must be less than or equal to the maximum progress value. |
| indeterminate | No | Boolean | Progress display type. The progress is displayed as a ratio by default.
|
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| firstLine | Yes | String | Text in the first line. The value contains a maximum of 128 characters and cannot be an empty string. |
| secondLine | Yes | String | Text in the second line. The value contains a maximum of 128 characters and cannot be an empty string. |
| underlineColor | No | String | Underline color of the text in the second line. The value is in #ARGB format, with a number sign (#) and 8 hexadecimal digits. If this parameter is not specified, the underline will not be displayed. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| firstLine | Yes | String | Text in the first line. The value contains a maximum of 128 characters and cannot be an empty string. |
| secondLine | Yes | String | Text in the second line. The value contains a maximum of 128 characters and cannot be an empty string. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| firstLine | Yes | String | Text in the first line. The value contains a maximum of 128 characters and cannot be an empty string. |
| secondLine | Yes | String | Text in the second line. The value contains a maximum of 128 characters and cannot be an empty string. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| indicatorIcon | No | String | Progress indicator icon, which is a local resource. If this parameter is not specified, the system displays the last updated image. When operation is set to 0 and indicatorType is set to 1 or 2, this parameter is mandatory and cannot be an empty string. The value is a file name in the specified path. Example: For the icon file icon.png stored in /resources/rawfile of the app, the value is icon.png. |
| progress | Yes | Integer | Progress percentage. The value ranges from 0 to 100. It determines the position of the indicator in the progress bar. |
| color | No | String | Color of the progress points and node icons on the left of the progress indicator. The value is in #ARGB format, with a number sign (#) and 8 hexadecimal digits. The default color is blue. |
| bgColor | No | String | Color of the progress points and node icons on the right of the progress indicator. The value is in #ARGB format, with a number sign (#) and 8 hexadecimal digits. The default color is gray. |
| nodeIcons | No | Array [String] | Icon of each node in the progress bar, which is a local resource. The array length range is [2, 5]. If this parameter is not specified, the system uses the last updated image. When operation is set to 0, this parameter is mandatory and cannot be an empty Array[String]. The value is a file name in the specified path. Example: For the icon file icon.png stored in /resources/rawfile of the app, the value is icon.png. |
| type | No | Integer | Progress display type in an extension area. The options are as follows:
|
| indicatorType | No | Integer | Display type of a small indicator icon in an extension area. The options are as follows:
|
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| time | No | Long | Initial value of the capsule timer, which is updated every second. The unit is millisecond (ms) and the default value is 0. |
| countDown | No | Boolean | Indicates whether a timer is a countdown timer. The default value is false.
|
| pause | No | Boolean | Indicates whether a capsule timer is paused. The default value is false.
|
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| type | No | Integer | Template type for a cover screen. The options are as follows:
|
| bgColor | No | String | Background color of a cover screen. The value is in #RGB format, with a number sign (#) and 6 hexadecimal digits. If this parameter is not specified, the default color is used. |
| bgImage | No | String | Background image of a cover screen, which is a local resource. When type is set to 1, this parameter is mandatory when an image is created and does not need to be set when the image is not updated. When operation is set to 0 and type is set to 1, this parameter is mandatory and cannot be an empty string. The value is a file name in the specified path. Example: For the icon file icon.png stored in /resources/rawfile of the app, the value is icon.png. |
| title | No | String | Custom notification title on a cover screen. The value contains a maximum of 128 characters. When operation is set to 0, this parameter is mandatory and cannot be an empty string. |
| body | No | Array [RichText Object] | Custom notification content on a cover screen, which consists of multiple rich text sections. The total text length cannot exceed 128 characters. If you set the text color, only one color can be specified. When operation is set to 0, this parameter is mandatory and cannot be an empty array. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| text | Yes | String | Text. |
| foregroundColor | No | String | Text color. The value is in #ARGB format, with a number sign (#) and 8 hexadecimal digits. If foregroundColor is not set, the default text color #FF000000 will be used. If foregroundColor is set, its values for all objects in the array must be the same. |
For details about the request body example, please refer to In-App Call Message.
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| extraData | Yes | String | Data transferred to an app. The app processes related logic based on the data and displays in-app call message information. (Note the message body size limits. For details, please refer to Restrictions.) |