PushNoticeToiOS-阿里云帮助中心

Operation description

This operation is deprecated. Use the Advanced Push API instead. Set the DeviceType parameter to iOS and the PushType parameter to NOTICE.

Before you use this operation, review the pricing and billing model for EMAS Mobile Push.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppKey	integer	Yes	Your AppKey.	24780725
Target	string	Yes	The target of the push. Valid values: DEVICE: Push to specific devices. ACCOUNT: Push to specific accounts. ALIAS: Push to users with specific aliases. TAG: Push to users with specific tags. ALL: Push to all devices.	ALL
TargetValue	string	Yes	Values depend on the Target value. Separate multiple values with commas. If you exceed the limit, send multiple requests. If Target=DEVICE, use values such as `deviceid111,deviceid1111`. Maximum: 1000. If Target=ACCOUNT, use values such as `account111,account222`. Maximum: 1000. If Target=ALIAS, use values such as `alias111,alias222`. Maximum: 1000. If Target=TAG, support single or multiple tags. For format details, see Tag format. If Target=ALL, set this to ALL.	ALL
ApnsEnv	string	Yes	iOS notifications use Apple’s APNs service. Specify the environment. DEV: Development environment. PRODUCT: Production environment.	DEV
Title	string	No	The title of the notification. iOS 10 and later: Displays as the notification title. iOS 8.2 through iOS 9.x: Replaces the app name in the notification.	title
Body	string	Yes	The body text of the notification.	Hello World
JobKey	string	No	A custom ID for the push task. If you specify a JobKey, the delivery log includes this field. For more information, see Delivery logs.	123
ExtParameters	string	No	A custom key-value map for developer extensions. Note For iOS devices, pass this parameter as a JSON object. Otherwise, parsing fails.	{"k1":"ios","k2":"v2"}

Response elements

Element	Type	Description	Example
	object
MessageId	string	The message ID for this push request.	9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC
RequestId	string	The request ID.	501029

Examples

Success response

JSON format

{
  "MessageId": "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC",
  "RequestId": "501029"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.