阅读423 返回首页    go 阿里云


推通知给iOS设备__推送相关_API 列表_OpenAPI 2.0_移动推送-阿里云

PushNoticeToiOS

描述

推送通知给iOS。

请求参数

名称 类型 是否必须 描述
Action String 操作接口名称,取值:PushNoticeToiOS
AppKey Long AppKey信息
Target String 推送目标:
  • DEVICE:根据设备推送
  • ACCOUNT:根据账号推送
  • ALIAS:根据别名推送
  • TAG:根据标签推送
  • ALL:推送给全部设备
TargetValue String 根据Target来设定,多个值使用逗号分隔,最多支持100个。
  • Target=DEVICE,值如deviceid111,deviceid1111
  • Target=ACCOUNT,值如account111,account222
  • Target=ALIAS,值如alias111,alias222
  • Target=TAG,支持单Tag和多Tag,格式请参考 标签格式
  • Target=ALL,值为all
ApnsEnv String iOS的通知是通过APNS中心来发送的,需要填写对应的环境信息,DEV表示开发环境,PRODUCT表示生产环境
Title String 发送的通知的标题(iOS10以上才会显示,可不填)
Body String 发送的通知内容
ExtParameters String 自定义的KV结构,开发者扩展用,针对iOS设备(注意 : 该参数要以json map的格式传入,否则会解析出错)

响应参数

名称 类型 描述
MessageId String 标志一次推送的消息ID

错误码

错误代码 描述 HTTP 状态码 语义
InvalidTarget Target must be [DEVICE、ACCOUNT、TAG、ALIAS、ALL]. 400 Target只能取DEVICE、ACCOUNT、TAG、ALIAS、ALL其中之一进行发送
InvalidParameter The specified Title.length can not be greater than 60.] 400 Title不能大于60个Byte(中文算三个)
AppLimitExceed The specified payload beyond the permitted range(1800Byte).] 400 请求内容超过系统限制,请参考产品限制
InvalidJsonExtParameter The specified ExtParameter is not valid json format of map. 400 ExtParameter参数应为json格式的map结构
InvalidEnv Env must be [DEV、PRODUCT]. 400 iOS的发送环境取DEV或者PRODUCT

示例

请求示例

  1. https://cloudpush.aliyuncs.com/?Action=PushNoticeToiOS
  2. &AppKey=23267207
  3. &Target=ALL&
  4. &TargetValue=ALL
  5. &ApnsEnv=DEV
  6. &Body=Hello World
  7. &ExtParameters={"k1":"ios","k2":"v2"}
  8. &<公共请求参数>

返回示例

XML格式

  1. <?xml version='1.0' encoding='UTF-8'?>
  2. <PushNoticeToiOSResponse>
  3. <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId>
  4. <MessageId>501029</MessageId>
  5. </PushNoticeToiOSResponse>

JSON格式

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

最后更新:2016-12-08 14:09:49

  上一篇:go 推通知给Android设备__推送相关_API 列表_OpenAPI 2.0_移动推送-阿里云
  下一篇:go 取消定时推送任务__推送相关_API 列表_OpenAPI 2.0_移动推送-阿里云