423
阿裏雲 技術社區[雲棲]
推通知給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,deviceid1111Target=ACCOUNT，值如account111,account222Target=ALIAS，值如alias111,alias222Target=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 |
示例
請求示例
https://cloudpush.aliyuncs.com/?Action=PushNoticeToiOS&AppKey=23267207&Target=ALL&&TargetValue=ALL&ApnsEnv=DEV&Body=Hello World&ExtParameters={"k1":"ios","k2":"v2"}&<公共請求參數>
返回示例
XML格式
<?xml version='1.0' encoding='UTF-8'?><PushNoticeToiOSResponse> <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId> <MessageId>501029</MessageId></PushNoticeToiOSResponse>
JSON格式
{ "RequestId": "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC", "MessageId": "501029"}
最後更新：2016-12-08 14:09:49