调用PushMessageToiOS推送消息给iOS。

接口说明

该接口默认只发送给在线设备,要发送离线保存消息请使用推送高级接口

调试

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

请求参数

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

系统规定参数。取值:PushMessageToiOS

AppKey Long 24780725

AppKey信息。

Body String my body

发送的消息内容。

Target String ALL

推送目标。可取值:

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

根据Target来设定,多个值使用逗号分隔,超过限制需要分多次推送。

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

发送的消息的标题。

JobKey String 123

推送任务自定义标识,当JobKey不为空时,回执日志中会附带该字段。查看回执日志参见回执日志

返回数据

名称 类型 示例值 描述
MessageId String 501029

标志一次推送的消息ID。

RequestId String 9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC

请求ID。

示例

请求示例

http(s)://cloudpush.aliyuncs.com/?Action=PushMessageToiOS
&AppKey=24780725
&Body=my body
&Target=ALL
&TargetValue=all
&Title=my title
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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