ContinuouslyPush

更新时间:
复制 MD 格式

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

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

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:

  • DEVICE: Push by device

  • ACCOUNT: Push by account

  • ALIAS: Push by alias

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.

  • Target=DEVICE: values such as deviceid1,deviceid2 (up to 1,000 supported).

  • Target=ACCOUNT: values such as account1,account2 (up to 1,000 supported).

  • Target=ALIAS: values such as alias1,alias2 (up to 1,000 supported).

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.