批量推送接口

接口说明

在某种业务场景中，可能需要在极短时间内大量向不同设备单推不同消息，在设备数、消息数极大时，会产生较高QPS，达到我们单来源IP的QPS限制，造成部分推送失败。

本接口针对此问题设计。它支持单次调用最大传入100个独立的推送任务，通过聚合请求的方式有效降低QPS，提高大量单推的稳定性和成功率。批量推送单账号限制每分钟100000调用。

每个独立推送任务仅支持根据设备/账号/别名三类推送目标，且暂不支持短信融合配置。

PushTask属性

• PushTask属性格式为：PushTask.N.Property。包含：
  • 推送目标(destination)
  • 推送配置(config)
  • iOS通知任务配置
  • Android通知任务配置
  • Android辅助弹窗功能配置
  • 推送控制(push control)
• 每一个PushTask表示一个独立推送任务，最大支持100个，推送相关配置，和Push接口一致。
• PushTask.N.Target参数只支持DEVICE、ACCOUNT、ALIAS三种类型。
• PushTask不支持短信融合配置。
• 父节点和子节点的乘积不能超过10000，否则视为参数无效。

请求参数

返回数据

示例

请求示例

http(s)://cloudpush.aliyuncs.com/?Action=MassPush
&AppKey=23267207
&PushTask.1.Body=hello
&PushTask.1.DeviceType=ALL
&PushTask.1.PushType=MESSAGE
&PushTask.1.Target=DEVICE
&PushTask.1.TargetValue=deviceid1,deviceid2
&<公共请求参数>

正常返回示例

XML格式

<MassPushResponse>
    <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId>
    <MessageIds>
        <MessageId>501030</MessageId>
        <MessageId>501031</MessageId>
        <MessageId>501032</MessageId>
    </MessageIds>
</MassPushResponse>

JSON格式

{
  "RequestId": "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC",
  "MessageIds": [
    "501030",
    "501031",
    "501031"
  ]
}

错误码

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

Java示例代码

MassPushRequest massPushRequest = new MassPushRequest();
massPushRequest.setAppKey(appKey);
List<MassPushRequest.PushTask> pushTasks = new ArrayList<>();
for (int i = 0; i < 100; i++) {
    MassPushRequest.PushTask pushTask = new MassPushRequest.PushTask();
    // 推送目标
    pushTask.setTarget("DEVICE"); //推送目标: DEVICE:推送给设备; ACCOUNT:推送给指定帐号,TAG:推送给自定义标签; ALIAS: 按别名推送; ALL: 全推
    pushTask.setTargetValue("device1,device2,device3"); //根据Target来设定，如Target=DEVICE, 则对应的值为 设备id1,设备id2. 多个值使用逗号分隔.(帐号与设备有一次最多100个的限制)
    pushTask.setDeviceType("iOS"); // 设备类型deviceType, iOS设备: "iOS"; Android设备: "ANDROID"; 全部: "ALL", 这是默认值.
    // 推送配置
    pushTask.setPushType("MESSAGE"); // MESSAGE:表示消息(默认), NOTICE:表示通知
    pushTask.setTitle("Hello-" + i); // 消息的标题
    pushTask.setBody("PushRequest body" + i); // 消息的内容
    // 推送配置: iOS
    pushTask.setIOSBadge(5); // iOS应用图标右上角角标
    pushTask.setIOSMusic("default"); // iOS通知声音
    pushTask.setIOSApnsEnv("PRODUCT");//iOS的通知是通过APNs中心来发送的，需要填写对应的环境信息。'DEV': 表示开发环境 'PRODUCT': 表示生产环境
    pushTask.setIOSRemind(true); //  消息推送时设备不在线（既与移动推送的服务端的长连接通道不通），则这条推送会做为通知，通过苹果的APNs通道送达一次。注意：**离线消息转通知仅适用于`生产环境`**
    pushTask.setIOSRemindBody("PushRequest summary"); // iOS消息转通知时使用的iOS通知内容，仅当iOSApnsEnv=`PRODUCT` && iOSRemind为true时有效
    pushTask.setIOSExtParameters("{\"k1\":\"ios\",\"k2\":\"v2\"}"); //通知的扩展属性(注意 : 该参数要以json map的格式传入,否则会解析出错)
    // 推送配置: Android
    pushTask.setAndroidOpenType("ACTIVITY"); // 点击通知后动作 'APPLICATION': 打开应用 'ACTIVITY': 打开应用AndroidActivity 'URL': 打开URL 'NONE': 无跳转
    pushTask.setAndroidNotifyType("SOUND"); // 通知的提醒方式 ‘VIBRATE': 振动  'SOUND': 声音 'DEFAULT': 声音和振动 'NONE': 不做处理，用户自定义
    pushTask.setAndroidOpenUrl("http://www.alibaba.com");
    pushTask.setAndroidMusic("default"); // Android通知声音
    pushTask.setAndroidActivity("com.alibaba.push.PushActivity"); // Android收到推送后打开对应的ACTIVITY,仅当`AndroidOpenType="ACTIVITY"`有效
    pushTask.setAndroidPopupActivity("com.alibaba.push.PopupActivity"); //设置该参数后启动辅助弹窗功能, 此处指定通知点击后跳转的Activity（辅助弹窗的前提条件：1. 集成第三方辅助通道；2. StoreOffline参数设为true）
    pushTask.setAndroidPopupTitle("Popup Title"); //设置辅助弹窗通知的标题
    pushTask.setAndroidPopupBody("Popup Body"); //设置辅助弹窗通知的内容
    pushTask.setAndroidNotificationBarType(50); //Android自定义通知栏样式，取值：1-100
    pushTask.setAndroidNotificationBarPriority(2); //Android通知在通知栏展示时排列位置的优先级 -2 -1 0 1 2
    pushTask.setAndroidExtParameters("{\"k1\":\"android\",\"k2\":\"v2\"}"); //设定通知的扩展属性。(注意 : 该参数要以 json map 的格式传入,否则会解析出错)
    // 推送控制
    final Date pushDate = new Date(System.currentTimeMillis() + 3600 * 1000); //用于定时发送。不设置缺省是立即发送。时间格式按照ISO8601标准表示，并需要使用UTC时间，格式为`YYYY-MM-DDThh:mm:ssZ`。
    final String pushTime = ParameterHelper.getISO8601Time(pushDate);
    pushTask.setPushTime(pushTime); // 延后推送。可选，如果不设置表示立即推送
    pushTask.setStoreOffline(true); // 离线消息是否保存,若保存, 在推送时候，用户即使不在线，下一次上线则会收到
    final String expireTime = ParameterHelper.getISO8601Time(new Date(System.currentTimeMillis() + 12 * 3600 * 1000)); // 12小时后消息失效, 不会再发送
    pushTask.setExpireTime(expireTime);
    pushTasks.add(pushTask);
}
massPushRequest.setPushTasks(pushTasks);
MassPushResponse massPushResponse = client.getAcsResponse(massPushRequest);
System.out.printf("RequestId: %s, MessageIds: %s\n", massPushResponse.getRequestId(), massPushResponse.getMessageIds().toString());