文档

PushNoticeToiOS - 推送通知给iOS设备

更新时间:

推送通知给iOS设备,iOS设备需要处于在线状态。

接口说明

请确保在使用该接口前,以充分了解 EMAS 移动推送产品的收费方式和价格

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppKeylong

AppKey 信息。

24780725
Targetstring

推送目标。可取值:

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

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

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

iOS 的通知是通过 APNS 中心来发送的,需要填写对应的环境信息。

  • DEV:表示开发环境
  • PRODUCT:表示生产环境
DEV
Titlestring

推送的通知的标题。

  • iOS 10+通知显示标题。
  • iOS 8.2 <= iOS 系统 < iOS 10:替换通知应用名称。
title
Bodystring

推送的通知内容。

Hello World
JobKeystring

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

123
ExtParametersstring

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

说明 针对 iOS 设备,该参数要以 JSON map 的格式传入,否则会解析出错。
{"k1":"ios","k2":"v2"}

返回参数

名称类型描述示例值
object
MessageIdstring

标志一次推送的消息 ID。

9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC
RequestIdstring

请求 ID。

501029

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-22API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)
文档反馈