消息模板 - 移动开发平台mPaaS

公共字段介绍

公共入参

参数	类型	是否必选	示例	描述
appId	String	是	ONEX570DA89211721	应用 ID
workspaceId	String	是	default	工作空间 ID
tenantId	String	是	LZFPEFIM	租户 ID

公共出参

参数	类型	示例	描述
requestId	String	B589F4F4-CD68-3CE5-BDA0-6597F33E23916512	请求 ID
success	boolean	true	是否请求成功
code	String	100	结果码
msg	String	SUCCESS	结果信息
data	Object	-	结果内容
currentPage	int	1	当前页码
pageSize	int	100	每页记录数
totalSize	int	80	总数

重要

创建模板、删除模板、分页查询和单个查询接口的出参展示的均为 Data 数据格式。
只有分页查询接口才包含 currentPage、pageSize 和 totalSize 参数。

结果码

结果码	结果信息	描述
100	SUCCESS	成功
3022	TEMPLATE_NOT_EXIST	模板不存在
3028	INVALID_PARAM	请检查一下参数
3036	TEMPLATE_ALREADY_EXIST	模板已存在
8011	FLOW_CONTROL_ERROR	流量控制
8012	INVALID_INSTANCE_ID	检查下 AppID 和 WorkspaceID
8013	INVALID_TENANT_ID	非法的 TenantID
8014	ACCOUNT_NO_PERMISSION	没有权限
9000	SYSTEM_ERROR	系统异常

创建模板

一个 App 最多能创建 100 个模板。

入参

参数	类型	是否必选	示例	描述
templateName	String	是	测试模板	模板名称，在控制台创建模板。说明模板名称不能包含逗号。
descInfo	String	是	模板描述	模板描述
title	String	是	模板标题	标题，如果是占位符，需要通过 `#` 包裹，如 `#title#`
content	String	是	模板内容	内容，如果是占位符，需要通过 `#` 包裹，如 `#content#`
uri	String	否	`mpaas://landing/startLand`	跳转地址
variables	String	否	`title,content`	占位字段，多个以逗号隔开
showStyle	long	否	0	是否静默： 0 - 否（默认） 1 - 是
imageUrls	String	否	`{"defaultUrl": "http://111"}`	当 pushStyle=2 时，表示大图地址。JSON 格式，默认获取 defaultUrl 的 value 值，如需区分厂商，可以把 key 改成 oppoUrl、miuiUrl、hmsUrl、honorUrl、harmonyosUrl 等
iconUrls	String	否	`{"defaultUrl": "http://111"}`	当 pushStyle=2 时，表示图标地址。JSON 格式，默认获取 defaultUrl 的 value 值，如果需要区分厂商，可以把 key 改成 iosUrl、oppoUrl、miuiUrl 等
pushStyle	int	否	0	展示样式： 0 - 普通文本（默认） 1 - 大文本 2 - 图文
jumpAction	int	否	0	点击后的动作类型： 0 - 网页（默认） 1 - 客户端自定义

出参

Data
参数	类型	示例	描述
data	String	8346	模板 ID

使用示例

import com.alibaba.fastjson.JSON;
import com.aliyun.mpaas20201028.Client;
import com.aliyun.mpaas20201028.models.CreateTemplateRequest;
import com.aliyun.mpaas20201028.models.CreateTemplateResponse;
import com.aliyun.teaopenapi.models.Config;

public static void main(String[] args) throws Exception {
    // 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
    // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
    // 本示例以将AccessKey ID和AccessKey Secret保存在环境变量为例说明。您也可以根据业务需要，保存到配置文件里。
    // 建议先完成环境变量配置
    Config config = new Config();
    // 必填，您的 AccessKey ID
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // 必填，您的 AccessKey Secret
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // mPaaS 的 REGION_ID 和 Endpoint,以杭州非金为例
    config.setRegionId("cn-hangzhou");
    config.setEndpoint("mpaas.cn-hangzhou.aliyuncs.com");
    Client client = new Client(config);

    CreateTemplateRequest request = new CreateTemplateRequest();
    request.setAppId("ONEX570DA89211721");
    request.setWorkspaceId("test");
    request.setTenantId("xxx");
    request.setTemplateName("创建测试模版");
    request.setContent("测试模版内容");
    request.setTitle("测试模版标题");
    request.setDescInfo("测试模版描述");
    CreateTemplateResponse response = client.createTemplate(request);
    System.out.println("response==>"+JSON.toJSONString(response));
}

删除模板

入参

参数	类型	是否必选	示例	描述
templateId	String	否	8346	模板 ID 和 templateName 二选一（优先级更高）
templateName	String	否	测试	模板名称和 templateId 二选一

出参

Data 为 null。

使用示例

import com.alibaba.fastjson.JSON;
import com.aliyun.mpaas20201028.Client;
import com.aliyun.mpaas20201028.models.DeleteTemplateRequest;
import com.aliyun.mpaas20201028.models.DeleteTemplateResponse;
import com.aliyun.teaopenapi.models.Config;

public static void main(String[] args) throws Exception {
    // 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
    // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
    // 本示例以将AccessKey ID和AccessKey Secret保存在环境变量为例说明。您也可以根据业务需要，保存到配置文件里。
    // 建议先完成环境变量配置
    Config config = new Config();
    // 必填，您的 AccessKey ID
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // 必填，您的 AccessKey Secret
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // mPaaS 的 REGION_ID 和 Endpoint,以杭州非金为例
    config.setRegionId("cn-hangzhou");
    config.setEndpoint("mpaas.cn-hangzhou.aliyuncs.com");
    Client client = new Client(config);

    DeleteTemplateRequest request = new DeleteTemplateRequest();
    request.setAppId("ONEX570DA89211721");
    request.setWorkspaceId("test");
    request.setTenantId("xxx");
    request.setTemplateName("创建测试模版");
    DeleteTemplateResponse response = client.deleteTemplate(request);
    System.out.println("response==>"+JSON.toJSONString(response));
}

分页查询

入参

参数	类型	是否必选	示例	描述
currentPage	int	否	1	当前页码，默认 1
pageSize	int	否	100	每页记录数，默认 100

出参

Data 类型为 List<Template>。

Template
参数	类型	示例	描述
id	String	8346	模板 ID
name	String	测试	模板名称
descInfo	String	模板描述	模板描述
title	String	模板标题	标题
content	String	模板内容	内容
uri	String	`mpaas://landing/startLand`	跳转地址
variables	String	`title,content`	占位字段
showStyle	String	0	是否静默
imageUrls	String	`{"defaultUrl": "http://111"}`	大图地址
iconUrls	String	`{"defaultUrl": "http://111"}`	图标地址
pushStyle	String	0	展示样式
action	String	0	点击后的动作类型
gmtCreate	String	1587376706000	创建时间
gmtModified	String	1587376706000	修改时间

使用示例

import com.alibaba.fastjson.JSON;
import com.aliyun.mpaas20201028.Client;
import com.aliyun.mpaas20201028.models.ListTemplatePageRequest;
import com.aliyun.mpaas20201028.models.ListTemplatePageResponse;
import com.aliyun.teaopenapi.models.Config;

public static void main(String[] args) throws Exception {
    // 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
    // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
    // 本示例以将AccessKey ID和AccessKey Secret保存在环境变量为例说明。您也可以根据业务需要，保存到配置文件里。
    // 建议先完成环境变量配置
    Config config = new Config();
    // 必填，您的 AccessKey ID
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // 必填，您的 AccessKey Secret
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // mPaaS 的 REGION_ID 和 Endpoint,以杭州非金为例
    config.setRegionId("cn-hangzhou");
    config.setEndpoint("mpaas.cn-hangzhou.aliyuncs.com");
    Client client = new Client(config);

    ListTemplatePageRequest request = new ListTemplatePageRequest();
    request.setAppId("ONEX570DA89211721");
    request.setWorkspaceId("test");
    request.setTenantId("xxx");
    request.setCurrentPage(1);
    request.setPageSize(2);
    ListTemplatePageResponse response = client.listTemplatePage(request);
    System.out.println("response==>"+JSON.toJSONString(response));
}

单个查询

入参

参数	类型	是否必选	示例	描述
templateId	String	否	8346	模板 ID 和 templateName 二选一（优先级更高）
templateName	String	否	测试	模板名称和 templateId 二选一

出参

Data 类型为 Template。

Template
参数	类型	示例	描述
id	String	8346	模板 ID
name	String	测试	模板名称
descInfo	String	模板描述	模板描述
title	String	模板标题	标题
content	String	模板内容	内容
uri	String	`mpaas://landing/startLand`	跳转地址
variables	String	`title,content`	占位字段
showStyle	String	0	是否静默
imageUrls	String	`{"defaultUrl": "http://111"}`	大图地址
iconUrls	String	`{"defaultUrl": "http://111"}`	图标地址
pushStyle	String	0	展示样式
action	String	0	点击后的动作类型
gmtCreate	String	1587376706000	创建时间
gmtModified	String	1587376706000	修改时间

使用示例

import com.alibaba.fastjson.JSON;
import com.aliyun.mpaas20201028.Client;
import com.aliyun.mpaas20201028.models.GetTemplateRequest;
import com.aliyun.mpaas20201028.models.GetTemplateResponse;
import com.aliyun.teaopenapi.models.Config;

public static void main(String[] args) throws Exception {
    // 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
    // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
    // 本示例以将AccessKey ID和AccessKey Secret保存在环境变量为例说明。您也可以根据业务需要，保存到配置文件里。
    // 建议先完成环境变量配置
    Config config = new Config();
    // 必填，您的 AccessKey ID
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // 必填，您的 AccessKey Secret
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // mPaaS 的 REGION_ID 和 Endpoint,以杭州非金为例
    config.setRegionId("cn-hangzhou");
    config.setEndpoint("mpaas.cn-hangzhou.aliyuncs.com");
    Client client = new Client(config);

    GetTemplateRequest request = new GetTemplateRequest();
    request.setAppId("ONEX570DA89211721");
    request.setWorkspaceId("test");
    request.setTenantId("xxx");
    request.setTemplateName("测试模版");
    GetTemplateResponse response = client.getTemplate(request);
    System.out.println("response==>"+JSON.toJSONString(response));
}