651      阿裏雲  技術社區[雲棲]

推送高級接口__API列表_OpenAPI 1.0_移動推送-阿裏雲

Push

描述

推送高級接口。

請求參數

• 通用參數請參考公共請求參數

基礎參數

推送目標(destination)

推送配置(config)

Title/Body/Summary 展開說明如下：

下述配置僅作用於iOS通知任務

• 【注意】若沒有進行iOS 10通知相關配置（iOSTitle / iOSSubTitle / iOSMutableContent / iOSNotificationCategory），通知payload保持老版本不變，已經保證對老版本payload兼容性；若進行iOS 10通知相關配置，請確保客戶端業務邏輯對payload相關字段處理的兼容性；iOS通知payload字段參考iOS 10通知適配-第3節。

下述配置僅作用於iOS消息

下述配置僅作用於Android通知任務

推送控製(push control)

響應參數

錯誤碼

對於所有接口的通用性錯誤，請參考錯誤代碼表。

示例

請求示例

https://cloudpush.aliyuncs.com/?Action=Push
&AppKey=23267207
&Target=device&
&TargetValue=e2ba19de97604f55b165576736477b74%2C92a1da34bdfd4c9692714917ce22d53d
&Title=hello
&Body=hello
&Type=1
&AndroidOpenType=1
&DeviceType=3
&Remind=false
&StoreOffline=false
&<公共請求參數>

返回示例

XML格式

<?xml version='1.0' encoding='UTF-8'?>
<PushResponse>
    <ResponseId>129376928</ResponseId>
</PushResponse>

JSON格式

{
  "ResponseId": "129377184"
}

Java示例代碼

PushRequest pushRequest = new PushRequest();
// 推送目標
pushRequest.setAppKey(appKey);
pushRequest.setTarget("all"); //推送目標: device:推送給設備; account:推送給指定帳號,tag:推送給自定義標簽; all: 推送給全部
pushRequest.setTargetValue("all"); //根據Target來設定，如Target=device, 則對應的值為 設備id1,設備id2. 多個值使用逗號分隔.(帳號與設備有一次最多100個的限製)
pushRequest.setDeviceType(3); // 設備類型deviceType 取值範圍為:0~3. iOS設備: 0; Android設備: 1; 全部: 3, 這是默認值.
// 推送配置
pushRequest.setType(1); // 0:表示消息(默認為0), 1:表示通知
pushRequest.setTitle("Hello"); // 消息的標題
pushRequest.setBody("PushRequest body"); // 消息的內容
pushRequest.setSummary("PushRequest summary"); // 通知的摘要
// 推送配置: iOS
pushRequest.setiOSBadge("5"); // iOS應用圖標右上角角標
pushRequest.setiOSMusic("default"); // iOS通知聲音
pushRequest.setiOSExtParameters("{"k1":"ios","k2":"v2"}"); //自定義的kv結構,開發者擴展用 針對iOS設備
pushRequest.setApnsEnv("DEV");
// pushRequest.setRemind(true); // 當APP不在線時候，是否通過通知提醒
// 推送配置: Android
pushRequest.setAndroidOpenType("3"); // 點擊通知後動作,1:打開應用 2: 打開應用Activity 3:打開 url
pushRequest.setAndroidOpenUrl("https://www.baidu.com"); // Android收到推送後打開對應的url,僅僅當androidOpenType=3有效
pushRequest.setAndroidExtParameters("{"k1":"android","k2":"v2"}"); // 設定android類型設備通知的擴展屬性
// 推送控製
final Date pushDate = new Date(System.currentTimeMillis() + 3600 * 1000); // 一小時後發送, 也可以設置成你指定固定時間
final String pushTime = ParameterHelper.getISO8601Time(pushDate);
pushRequest.setPushTime(pushTime); // 延後推送。可選，如果不設置表示立即推送
pushRequest.setStoreOffline(true); // 離線消息是否保存,若保存, 在推送時候，用戶即使不在線，下一次上線則會收到
final String expireTime = ParameterHelper.getISO8601Time(new Date(System.currentTimeMillis() + 12 * 3600 * 1000)); // 12小時後消息失效, 不會再發送
pushRequest.setExpireTime(expireTime);
PushResponse pushResponse = client.getAcsResponse(pushRequest);
System.out.printf("RequestId: %s, ResponseId: %s, message: %sn",
        pushResponse.getRequestId(), pushResponse.getResponseId(), pushResponse.getMessage());

com.aliyuncs.exceptions.ClientException: Push Failed : Push Fail!  排查步驟
1、檢查SDK的版本號，是否是最新版本？
2、title是不是大於20個字符了？
3、是不是有必填參數沒有填寫？ 高級接口因為既可以發送iOS也可以發送Android，所以iOS和Android必填參數都需要填寫，參數的完整性校驗之後才會按照參數設置走iOS或者Android的發送流程。