Executes a predefined continuous push task.
Operation description
This API addresses the limitations of the Push Advanced Push API, where push-by-device, push-by-account, and push-by-alias operations each have a maximum target count per single call.
-
You can use continuous push when your scenario requires sending the same message to many devices. In this case, you can call the continuous push API repeatedly, each time specifying a group of targets for aggregation (the current limit is 1,000 targets per call for device, account, or alias pushes). The total number of pushes for the same MessageId is restricted to 10,000. If you need a higher limit, contact technical support to evaluate your specific scenario.
-
Before using this API, you must first call the Push API with Target set to TBD (To Be Determined) and include your message content. This returns a MessageId from the push system. You can then use this MessageId to repeatedly call the continuous push API, specifying different target groups to deliver the same message.
-
After calling the Push API with Target set to TBD and obtaining a MessageId, the message is stored in the push system for 24 hours by default. You can use this API to push to specified targets at any time before expiration. Pushes are not allowed after expiration or after reaching the total push limit.
-
Each call to this API sends the message immediately. Scheduled pushes are not supported.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
mpush:ContinuouslyPush |
none |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| AppKey |
integer |
Yes |
AppKey information. |
23267207 |
| MessageId |
string |
Yes |
Message ID. Obtain this MessageId by calling the Push API with Target set to TBD. It represents a message already saved in the push system. |
500131 |
| Target |
string |
Yes |
Push target:
Continuous push supports only these three target types. |
DEVICE |
| TargetValue |
string |
Yes |
Specify values based on Target. Separate multiple values with commas. If you exceed the limit, split the push into multiple calls.
|
a692961a92534047ad3625**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| MessageId |
string |
The message ID that identifies a push request. |
9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC |
| RequestId |
string |
Request ID. |
500131 |
Examples
Success response
JSON format
{
"MessageId": "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC",
"RequestId": "500131"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.