调用PushNoticeToiOS推送通知给iOS设备。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String PushNoticeToiOS

系统规定参数。取值:PushNoticeToiOS

ApnsEnv String DEV

iOS的通知是通过APNS中心来发送的,需要填写对应的环境信息,DEV表示开发环境,PRODUCT表示生产环境。

AppKey Long 24780725

AppKey信息。

Body String Hello World

发送的通知内容。

Target String ALL

推送目标。可取值:

  • DEVICE:根据设备推送
  • ACCOUNT:根据账号推送
  • ALIAS:根据别名推送
  • TAG:根据标签推送
  • ALL:推送给全部设备
TargetValue String ALL

根据Target来设定,多个值使用逗号分隔,最多支持100个。

  • Target=DEVICE,值如deviceid111,deviceid1111
  • Target=ACCOUNT,值如account111,account222
  • Target=ALIAS,值如alias111,alias222
  • Target=TAG,支持单Tag和多Tag,格式请参见标签格式
  • Target=ALL,值为ALL
Title String title

发送的通知的标题(iOS10以上才会显示,可不填)。

JobKey String 123

JobKey信息。

ExtParameters String {"k1":"ios","k2":"v2"}

自定义的KV结构,开发者扩展用。

说明 针对iOS设备,该参数要以Json map的格式传入,否则会解析出错。

返回数据

名称 类型 示例值 描述
MessageId String 9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC

标志一次推送的消息ID。

RequestId String 501029

请求ID。

示例

请求示例

http(s)://cloudpush.aliyuncs.com/?Action=PushNoticeToiOS
&ApnsEnv=DEV
&AppKey=24780725
&Body=Hello World
&Target=ALL
&TargetValue=ALL
&<公共请求参数>

正常返回示例

XML 格式

<PushNoticeToiOSResponse>
      <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId>
      <MessageId>501029</MessageId>
</PushNoticeToiOSResponse>

JSON 格式

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

错误码

访问错误中心查看更多错误码。