調用服務端API管理訊息推送模板-移動開發平台 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));
}