Mobile Platform as a Service:Message template

Common fields description

Input parameters

Output parameters

Response codes

Create a template

A maximum of 100 templates can be created for one App.

Input parameters

Output parameters

Example

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 {
    // The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. We recommend that you use a RAM user to call API operations or perform routine O&M. 
    // We recommend that you do not save your AccessKey ID and AccessKey secret in your project code. Otherwise, the AccessKey pair may be leaked and the security of all resources within your account is compromised. 
    // In this example, the AccessKey ID and AccessKey secret are saved as environment variables. You can also save the AccessKey pair in the configuration file based on your business requirements. 
    // We recommend that you configure environment variables first.
    Config config = new Config();
    // Required: Your AccessKey ID
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // Required: Your AccessKey Secret
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // the REGION_ID and Endpoint of mPaaS, taking Hangzhou Non-Financial area as an example
    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("Create a test template");
    request.setContent("Test template content");
    request.setTitle("Test template title");
    request.setDescInfo("Test template description");
    CreateTemplateResponse response = client.createTemplate(request);
    System.out.println("response==>"+JSON.toJSONString(response));
}  

Delete a template

Input parameters

Output parameters

Data is null.

Example

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 {
    // The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. We recommend that you use a RAM user to call API operations or perform routine O&M. 
    // We recommend that you do not save your AccessKey ID and AccessKey secret in your project code. Otherwise, the AccessKey pair may be leaked and the security of all resources within your account is compromised. 
    // In this example, the AccessKey ID and AccessKey secret are saved as environment variables. You can also save the AccessKey pair in the configuration file based on your business requirements. 
    // We recommend that you configure environment variables first.
    Config config = new Config();
    // Required: Your AccessKey ID
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // Required: Your AccessKey Secret
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // the REGION_ID and Endpoint of mPaaS, taking Hangzhou Non-Financial area as an example
    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("Create a test template");
    DeleteTemplateResponse response = client.deleteTemplate(request);
    System.out.println("response==>"+JSON.toJSONString(response));
}

Paged query

Input parameters

Output parameters

Data type is List<Template>.

Example

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 {
    // The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. We recommend that you use a RAM user to call API operations or perform routine O&M. 
    // We recommend that you do not save your AccessKey ID and AccessKey secret in your project code. Otherwise, the AccessKey pair may be leaked and the security of all resources within your account is compromised. 
    // In this example, the AccessKey ID and AccessKey secret are saved as environment variables. You can also save the AccessKey pair in the configuration file based on your business requirements. 
    // We recommend that you configure environment variables first.
    Config config = new Config();
    // Required: Your AccessKey ID
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // Required: Your AccessKey Secret
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // the REGION_ID and Endpoint of mPaaS, taking Hangzhou Non-Financial area as an example
    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));
}

Single query

Input parameters

Output parameters

Data type is Template.

Example

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 {
    // The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. We recommend that you use a RAM user to call API operations or perform routine O&M. 
    // We recommend that you do not save your AccessKey ID and AccessKey secret in your project code. Otherwise, the AccessKey pair may be leaked and the security of all resources within your account is compromised. 
    // In this example, the AccessKey ID and AccessKey secret are saved as environment variables. You can also save the AccessKey pair in the configuration file based on your business requirements. 
    // We recommend that you configure environment variables first.
    Config config = new Config();
    // Required: Your AccessKey ID
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // Required: Your AccessKey Secret
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // the REGION_ID and Endpoint of mPaaS, taking Hangzhou Non-Financial area as an example
    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("Test template");
    GetTemplateResponse response = client.getTemplate(request);
    System.out.println("response==>"+JSON.toJSONString(response));
}