651      iPhone_iPad_Mac_手机_平板_苹果apple

推送高级接口__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的发送流程。