推送通知到 iOS 设备端,通知通过苹果APNs通道下发,并直接在设备通知栏弹出。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
mpush:PushNoticeToiOS |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AppKey |
integer |
是 |
AppKey 信息。 |
24780725 |
| Target |
string |
是 |
推送目标。可取值:
|
ALL |
| TargetValue |
string |
是 |
根据 Target 来设定,多个值使用逗号分隔,超过限制需要分多次推送。
|
ALL |
| ApnsEnv |
string |
是 |
iOS 的通知是通过 APNS 中心来发送的,需要填写对应的环境信息。
|
DEV |
| Title |
string |
否 |
推送的通知的标题。
|
title |
| Body |
string |
是 |
推送的通知内容。 |
Hello World |
| JobKey |
string |
否 |
推送任务自定义标识,当 JobKey 不为空时,回执日志中会附带该字段。查看回执日志参见回执日志。 |
123 |
| ExtParameters |
string |
否 |
自定义的 KV 结构,开发者扩展用。 说明
针对 iOS 设备,该参数要以 JSON map 的格式传入,否则会解析出错。 |
{"k1":"ios","k2":"v2"} |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| MessageId |
string |
标志一次推送的消息 ID。 |
9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC |
| RequestId |
string |
请求 ID。 |
501029 |
示例
正常返回示例
JSON格式
{
"MessageId": "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC",
"RequestId": "501029"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。