调用PushNoticeToiOS推送通知给iOS设备。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | PushNoticeToiOS |
系统规定参数。取值:PushNoticeToiOS。 |
AppKey | Long | 是 | 24780725 |
AppKey信息。 |
Target | String | 是 | ALL |
推送目标。可取值:
|
TargetValue | String | 是 | ALL |
根据Target来设定,多个值使用逗号分隔,超过限制需要分多次推送。
|
ApnsEnv | String | 是 | DEV |
iOS的通知是通过APNS中心来发送的,需要填写对应的环境信息,DEV表示开发环境,PRODUCT表示生产环境。 |
Title | String | 否 | title |
发送的通知的标题(iOS10以上才会显示,可不填)。 |
Body | String | 是 | Hello World |
发送的通知内容。 |
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)://[Endpoint]/?Action=PushNoticeToiOS
&AppKey=24780725
&Target=ALL
&TargetValue=ALL
&ApnsEnv=DEV
&Title=title
&Body=Hello World
&JobKey=123
&ExtParameters={"k1":"ios","k2":"v2"}
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<PushNoticeToiOSResponse>
<MessageId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</MessageId>
<RequestId>501029</RequestId>
</PushNoticeToiOSResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"MessageId" : "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC",
"RequestId" : "501029"
}
错误码
访问错误中心查看更多错误码。