API 说明 - 服务端_参考_消息推送_移动开发平台mPaaS-阿里云

消息推送包含以下服务端 API 接口，具体描述见下表：

API	描述
极简推送	对一个目标 ID 推送一条消息。
模板推送	对一个目标 ID 推送一条消息，消息通过模板创建。
批量推送	对多个目标 ID 推送不同消息。基于模板，为各推送 ID 配置不同的模板占位符内容，从而实现消息的个性化推送。
群发推送	对全网设备推送相同消息，消息通过模板进行创建。

推送准备

在调用以下四种推送方式前，需引入 maven 配置，在主控 pom 中引入如下依赖：

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-mpaas</artifactId>
    <version>1.0.0.0</version>
</dependency>
<dependency>
<groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-core</artifactId>
  <optional>true</optional>
  <version>[4.3.2,5.0.0)</version>
</dependency>

注意： 在下文分别提供了 简单推送、模板推送、批量推送、群发推送 四种方式的 API 示例代码供您参考，使用前请确保您使用的 httpclient 的版本大于 4.5.X，否则可能会出现使用故障。

极简推送

对一个推送 ID 推送一条消息。

说明：在调用本接口之前，您需要引入依赖，详见推送准备。

参数说明

参数名称	类型	是否必填	示例	描述
taskName	String	是	simpleTest	推送任务名称。
title	String	是	测试	消息的标题。
content	String	是	测试	消息的正文。
appId	String	是	ONEX570DA89211721	mpaas appid
workspaceId	String	是	test	mpaas workspace
deliveryType	Long	是	3	目标 ID 类型，数值选择如下： 1 为 Android 设备维度 2 为 iOS 设备维度 3 为用户维度
targetMsgkey	String	是	{“user1024”:”1578807462788”}	推送目标，为 map 形式： key: 为目标，配合 `deliveryType`。如果 `deliveryType` 为 3 ，则 key 为 `userid`。 value：消息业务 ID。需注意，推送目标不可以超过 10 个。
expiredSeconds	Long	是	300	消息有效期，单位为秒。
extendedParams	String	否	{“key1”:”value1”}	扩展参数，为 map 形式。
pushAction	Long	否	0	点击消息后的跳转方式： 0 为 web URL 1 为 Intent activity 默认为 web URL。
uri	String	否	http://www	点击消息后的跳转地址。
silent	Long	否	1	是否静默： 1 为静默 0 为非静默

代码示例

说明：点击这里查看下方代码示例中 AccessKeyId 与 AccessKeySecret 的获取方式。

 DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 创建 DefaultAcsClient 实例并初始化
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",    // 地域 ID
            "******",        // RAM 账号的 AccessKey ID
            "*****");         // RAM 账号的 AccessKey Secret
        IAcsClient client = new DefaultAcsClient(profile);
        // Create an API request and set parameters
        PushSimpleRequest request = new PushSimpleRequest();
        request.setAppId("ONEX570DA89211721");
        request.setWorkspaceId("test");
        request.setTaskName("测试任务");
        request.setTitle("测试");
        request.setContent("测试");
        request.setDeliveryType(3L);
        Map<String,String> extendedParam = new HashMap<String, String>();
        extendedParam.put("key1","value1");
        request.setExtendedParams(JSON.toJSONString(extendedParam));
        request.setExpiredSeconds(300L);
        Map<String,String> target = new HashMap<String, String>();
        String msgKey = String.valueOf(System.currentTimeMillis());
        target.put("user1024",msgKey);
        request.setTargetMsgkey(JSON.toJSONString(target));
        // Initiate the request and handle the response or exceptions
        PushSimpleResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

模板推送

模板推送指针对单个目标 ID 的消息推送，消息通过模板创建。多个 ID 可以使用同一个模板。

说明：

在调用本接口之前，您需要先在消息推送控制台上创建好目标模板，详细操作参见创建模板。
在调用本接口之前，您需要引入依赖，详见推送准备。

参数说明

参数名称	类型	是否必填	示例	描述
taskName	String	是	模板测试	推送任务名称。
appId	String	是	ONEX570DA89211721	mpaas appid
workspaceId	String	是	test	mpaas workspace
deliveryType	Long	是	3	目标 ID 类型，数值选择如下： 1 为 Android 设备维度 2 为 iOS 设备维度 3 为用户维度
targetMsgkey	String	是	{“user1024”:”1578807462788”}	推送目标，为 map 形式： key: 为目标，配合 `deliveryType`。如果 `deliveryType` 为 3 ，则 key 为 `userid`。 value：消息业务 ID。需注意，推送目标不可以超过 10 个。
expiredSeconds	Long	是	300	消息有效期，单位为秒。
templateName	String	是	测试模板	模板名称，在控制台创建模板。
templateKeyValue	String	否	{“money”:”200”,”name”:”张三”}	模板参数，为 map 格式，和 `templateName` 指定的模板对应，key 为占位符名称，value 为要替换的值，例如模板内容为（两个 `#` 之间为占位符名称） `恭喜#name#中了#money#元`。
extendedParams	String	否	{“key1”:”value1”}	扩展参数，为 map 形式。

代码示例

说明：点击这里查看下方代码示例中 AccessKeyId 与 AccessKeySecret 的获取方式。

 DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 创建 DefaultAcsClient 实例并初始化
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",        // 地域 ID
            "******",        // RAM 账号的 AccessKey ID
            "******");         // RAM 账号的 AccessKey Secret
        IAcsClient client = new DefaultAcsClient(profile);
        // Create an API request and set parameters
        PushTemplateRequest request = new PushTemplateRequest();
        request.setAppId("ONEX570DA89211721");
        request.setWorkspaceId("test");
        request.setTemplateName("测试模板");
        //你好#name#,恭喜中奖#money#元
        Map<String,String> templatekv = new HashMap<String, String>();
        templatekv.put("name","张三");
        templatekv.put("money","200");
        request.setTemplateKeyValue(JSON.toJSONString(templatekv));
        request.setExpiredSeconds(600L);
        request.setTaskName("模板测试");
        request.setDeliveryType(3L);
        Map<String,String> target = new HashMap<String, String>();
        String msgKey = String.valueOf(System.currentTimeMillis());
        target.put("userid1024",msgKey);
        request.setTargetMsgkey(JSON.toJSONString(target));
        PushTemplateResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

批量推送

对各个推送 ID 推送不同消息。通过替换模板占位符的方式，创建针对某一推送 ID 的个性化消息。与模板推送的区别在于，每一个推送ID 可以收到内容不相同的消息。

说明：

在调用本接口之前，您需要先在消息推送控制台上创建好目标模板，并确保模板中存在占位符，否则将无法实现消息的个性化推送（即对不同推送 ID 推送不同消息）。详细操作参见创建模板。
在调用本接口之前，您需要引入依赖，详见推送准备。

参数说明

参数名称	类型	是否必填	示例	描述
taskName	String	是	批量测试	推送任务名称。
appId	String	是	ONEX570DA89211721	mpaas appid
workspaceId	String	是	test	mpaas workspace
deliveryType	Long	是	3	目标 ID 类型，数值选择： 1 为 Android 设备维度 2 为 iOS 设备维度 3 为用户维度
templateName	String	是	测试模板	模板名称，在控制台创建模板。
targetMsgs	List	是	TargetMsg 对象的list	目标对象列表，参数详见下方的 TargetMsg 对象。
expiredSeconds	Long	是	300	消息有效期，单位为秒。
extendedParams	String	否	{“key1”:”value1”}	统一扩展参数，为 map 形式。

TargetMsg 对象

参数名称	类型	是否必填	示例	描述
target	String	是	userid1024	目标 ID，根据 deliveryType 类型填写。
msgKey	String	是	1578807462788	业务消息 ID，用于消息的排查。由用户定义，不可重复。
templateKeyValue	String	否	{“money”:”200”,”name”:”张三”}	模板参数，为 map 形式，和 `templateName` 指定的模板对应，key 为占位符名称，value 为要替换的值，例如模板内容为（两个 `#` 之间为占位符名称） `恭喜#name#中了#money#元`。
extendedParams	String	否	{“key1”:”value1”}	扩展参数，为 map 形式，针对每条消息的不同扩展参数。

代码示例

说明：点击这里查看下方代码示例中 AccessKeyId 与 AccessKeySecret 的获取方式。

 DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 创建 DefaultAcsClient 实例并初始化
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",        // 地域 ID
            "******",        // RAM 账号的 AccessKey ID
            "******");         // RAM 账号的 AccessKey Secret
        IAcsClient client = new DefaultAcsClient(profile);
        // Create an API request and set parameters
        PushMultipleRequest request = new PushMultipleRequest();
        request.setAppId("ONEX570DA89211721");
        request.setWorkspaceId("test");
        request.setDeliveryType(3L);
        request.setTaskName("批量测试");
        request.setTemplateName("测试模板");
        //你好#name#,恭喜中奖#money#元
        List<PushMultipleRequest.TargetMsg> targetMsgs = new ArrayList<PushMultipleRequest.TargetMsg>();
        PushMultipleRequest.TargetMsg targetMsg = new PushMultipleRequest.TargetMsg();
        targetMsg.setTarget("userid1024");
        targetMsg.setMsgKey(String.valueOf(System.currentTimeMillis()));
        Map<String, String> templatekv = new HashMap<String, String>();
        templatekv.put("name", "张三");
        templatekv.put("money", "200");
        targetMsg.setTemplateKeyValue(JSON.toJSONString(templatekv));
        //目标数量不要超过400个
        targetMsgs.add(targetMsg);
        request.setTargetMsgs(targetMsgs);
        request.setExpiredSeconds(600L);
        PushMultipleResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

群发推送

对全网设备推送相同消息，消息通过模板创建。

说明：

在调用本接口之前，您需要先在消息推送控制台上创建好目标模板，详细操作参见创建模板。
在调用本接口之前，您需要引入依赖，详见推送准备。

参数说明

参数名称	类型	是否必填	示例	描述
taskName	String	是	群发测试任务	推送任务名称。
appId	String	是	ONEX570DA89211721	mpaas appid
workspaceId	String	是	test	mpaas workspace
deliveryType	Long	是	1	目标 ID 类型，数值选择： 1 为 Android 群发 2 为 iOS 群发
msgkey	String	是	1578807462788	业务方消息 ID，用户自定义，不可重复。
expiredSeconds	Long	是	300	消息有效期，单位为秒。
templateName	String	是	群发模板	模板名称，在控制台创建模板。
templateKeyValue	String	否	{“content”:”公告内容”}	模板参数，为 map 格式，和 `templateName` 指定的模板对应，key 为占位符名称，value 为要替换的值。
pushStatus	Long	否	0	针对 iOS 群发，群发时，推送登录状态： 0 所有当前绑定的用户（默认） 1 所有用户（包括解绑的用户）
unBindPeriod	Long	否	1	退出登录时长，当 `pushStatus` 为 1 时为必填： 1 表示 7 天内解绑的用户 2 表示 15 天内解绑的用户 3 表示 60 天内解绑的用户 4 表示永久

代码示例

说明：点击这里查看下方代码示例中 AccessKeyId 与 AccessKeySecret 的获取方式。

DefaultProfile.addEndpoint("cn-hangzhou", "mpaas", "mpaas.cn-hangzhou.aliyuncs.com");
        // 创建 DefaultAcsClient 实例并初始化
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",        // 地域 ID
            "******",         // RAM 账号的 AccessKey ID
            "******");         // RAM 账号的 AccessKey Secret
        IAcsClient client = new DefaultAcsClient(profile);
        PushBroadcastRequest request = new PushBroadcastRequest();
        request.setAppId("ONEX570DA89211720");
        request.setWorkspaceId("test");
        request.setDeliveryType(2L);
        request.setMsgkey(String.valueOf(System.currentTimeMillis()));
        request.setExpiredSeconds(600L);
        request.setTaskName("群发任务");
        request.setTemplateName("群发测试");
        //这是一个公告:#content#
        Map<String, String> templatekv = new HashMap<String, String>();
        templatekv.put("content", "公告内容");
        request.setTemplateKeyValue(JSON.toJSONString(templatekv));
        PushBroadcastResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }