All Products
Search

This Product

    Mobile Platform as a Service:Message template

    Document Center

    Mobile Platform as a Service:Message template

    Last Updated:Apr 24, 2025

    Common fields description

    Input parameters

    Parameter

    Type

    Required

    Example

    Description

    appId

    String

    Yes

    ONEX570DA89211721

    Application ID

    workspaceId

    String

    Yes

    default

    Workspace ID

    tenantId

    String

    Yes

    LZFPEFIM

    Tenant ID

    Output parameters

    Parameter

    Type

    Example

    Description

    requestId

    String

    B589F4F4-CD68-3CE5-BDA0-6597F33E23916512

    Request ID

    success

    boolean

    true

    Indicates whether the request was successful

    code

    String

    100

    Response code

    msg

    String

    SUCCESS

    The returned message

    data

    Object

    -

    Result content

    currentPage

    int

    1

    The current page number

    pageSize

    int

    100

    Number of records per page

    totalSize

    int

    80

    Total number

    Important

    • The output parameters of the "Create template, Delete template, Paged query, Single query" APIs are all display in Data format.

    • Only the Paged query API includes the parameters: currentPage, pageSize, totalSize.

    Response codes

    Response code

    Result message

    Description

    100

    SUCCESS

    The operation was successful

    3022

    TEMPLATE_NOT_EXIST

    Template not found

    3028

    INVALID_PARAM

    Please check the parameters

    3036

    TEMPLATE_ALREADY_EXIST

    Template already exists

    8011

    FLOW_CONTROL_ERROR

    Traffic control

    8012

    INVALID_INSTANCE_ID

    Check the AppID and WorkspaceID

    8013

    INVALID_TENANT_ID

    Invalid TenantID

    8014

    ACCOUNT_NO_PERMISSION

    You do not have the required permissions

    9000

    SYSTEM_ERROR

    System error

    Create a template

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

    Input parameters

    Parameter

    Type

    Required

    Example

    Description

    templateName

    String

    Yes

    Test template

    Template name

    descInfo

    String

    Yes

    Template description

    Template description

    title

    String

    Yes

    Template title

    Title. If it is a placeholder, it needs to be wrapped with #, such as #title#

    content

    String

    Yes

    Template content

    Content. If it is a placeholder, it needs to be wrapped with #, such as #content#

    uri

    String

    No

    mpaas://landing/startLand

    Jump URL

    variables

    String

    No

    title,content

    Placeholder fields, separated by commas

    showStyle

    long

    No

    0

    Silent mode:

    • 0 - No (default)

    • 1 - Yes

    imageUrls

    String

    No

    {"defaultUrl": "http://111"}

    When pushStyle=2, it indicates the URL of the large image. In JSON format, the default value of defaultUrl is obtained by default. If you need to distinguish the vendors, you can change the key to oppoUrl, miuiUrl, hmsUrl, honorUrl, harmonyosUrl, etc

    iconUrls

    String

    No

    {"defaultUrl": "http://111"}

    When pushStyle=2, it indicates the icon address. In JSON format, the default value of defaultUrl is obtained by default. If you need to distinguish the vendors, you can change the key to iosUrl, oppoUrl, miuiUrl, etc.

    pushStyle

    int

    No

    0

    Display style:

    • 0 - Plain text (default)

    • 1 - Large text

    • 2 - Image and text

    jumpAction

    int

    No

    0

    Action type after clicking:

    • 0 - Web page (default)

    • 1 - Client customization

    Output parameters

    Data

    Parameter

    Type

    Example

    Description

    data

    String

    8346

    Template ID

    Example

    DefaultProfile.addEndpoint(REGION_ID, PRODUCT, ENDPOINT);
DefaultProfile profile = DefaultProfile.getProfile(
    REGION_ID,          // Region ID
    ACCESS_KEY_ID,      // RAM account AccessKey ID
    ACCESS_KEY_SECRET); // RAM account AccessKey Secret
IAcsClient client = new DefaultAcsClient(profile);
CreateTemplateRequest request = new CreateTemplateRequest();
request.setAppId("ONEX570DA89211721");
request.setWorkspaceId("default");
request.setTenantId("LZFPEFIM");
request.setTemplateName("Create test template");
request.setContent("Test template content");
request.setTitle("Test template title");
request.setDescInfo("Test template description");
CreateTemplateResponse response = client.getAcsResponse(request);

    Delete a template

    Input parameters

    Parameter

    Type

    Required

    Example

    Description

    templateId

    String

    No

    8346

    Either template ID or templateName (higher priority)

    templateName

    String

    No

    Test

    Template name or templateId

    Output parameters

    Data is null.

    Example

    DefaultProfile.addEndpoint(REGION_ID, PRODUCT, ENDPOINT);
DefaultProfile profile = DefaultProfile.getProfile(
    REGION_ID,          // Region ID
    ACCESS_KEY_ID,      // RAM account AccessKey ID
    ACCESS_KEY_SECRET); // RAM account AccessKey Secret
IAcsClient client = new DefaultAcsClient(profile);
DeleteTemplateRequest request = new DeleteTemplateRequest();
request.setAppId("ONEX570DA89211721");
request.setWorkspaceId("default");
request.setTenantId("LZFPEFIM");
request.setTemplateName("Create test template");
DeleteTemplateResponse response = client.getAcsResponse(request);

    Paged query

    Input parameters

    Parameter

    Type

    Required

    Example

    Description

    currentPage

    int

    No

    1

    Current page number, default is 1

    pageSize

    int

    No

    100

    Number of records per page, default is 100

    Output parameters

    Data type is List<Template>.

    Template

    Parameter

    Type

    Example

    Description

    id

    String

    8346

    Template ID

    name

    String

    Test

    Template name

    descInfo

    String

    Template description

    Template description

    title

    String

    Template title

    Title

    content

    String

    Template content

    Content

    uri

    String

    mpaas://landing/startLand

    Jump URL

    variables

    String

    title,content

    Placeholder fields

    showStyle

    String

    0

    Silent mode

    imageUrls

    String

    {"defaultUrl": "http://111"}

    Large image URL

    iconUrls

    String

    {"defaultUrl": "http://111"}

    Icon URL

    pushStyle

    String

    0

    Display style

    action

    String

    0

    Action type after clicking

    gmtCreate

    String

    1587376706000

    The time when the template was created

    gmtModified

    String

    1587376706000

    The time when the template was modified

    Example

    DefaultProfile.addEndpoint(REGION_ID, PRODUCT, ENDPOINT);
DefaultProfile profile = DefaultProfile.getProfile(
    REGION_ID,          // Region ID
    ACCESS_KEY_ID,      // RAM account AccessKey ID
    ACCESS_KEY_SECRET); // RAM account AccessKey Secret
IAcsClient client = new DefaultAcsClient(profile);
ListTemplatePageRequest request = new ListTemplatePageRequest();
request.setAppId("ONEX570DA89211721");
request.setWorkspaceId("default");
request.setTenantId("LZFPEFIM");
request.setCurrentPage(1);
request.setPageSize(50);
ListTemplatePageResponse response = client.getAcsResponse(request);

    Single query

    Input parameters

    Parameter

    Type

    Required

    Example

    Description

    templateId

    String

    No

    8346

    Either template ID or templateName (higher priority)

    templateName

    String

    No

    Test

    Template name or templateId

    Output parameters

    Data type is Template.

    Template

    Parameter

    Type

    Example

    Description

    id

    String

    8346

    Template ID

    name

    String

    Test

    Template name

    descInfo

    String

    Template description

    Template description

    title

    String

    Template title

    Title

    content

    String

    Template content

    Content

    uri

    String

    mpaas://landing/startLand

    Link URL

    variables

    String

    title,content

    Placeholder fields

    showStyle

    String

    0

    Silent mode

    imageUrls

    String

    {"defaultUrl": "http://111"}

    Large image URL

    iconUrls

    String

    {"defaultUrl": "http://111"}

    Icon URL

    pushStyle

    String

    0

    Display style

    action

    String

    0

    Action type after clicking

    gmtCreate

    String

    1587376706000

    The time when the template was created

    gmtModified

    String

    1587376706000

    The time when the template was modified

    Example

    DefaultProfile.addEndpoint(REGION_ID, PRODUCT, ENDPOINT);
DefaultProfile profile = DefaultProfile.getProfile(
    REGION_ID,          // Region ID
    ACCESS_KEY_ID,      // RAM account AccessKey ID
    ACCESS_KEY_SECRET); // RAM account AccessKey Secret
GetTemplateRequest request = new GetTemplateRequest();
request.setAppId("ONEX570DA89211721");
request.setWorkspaceId("default");
request.setTenantId("LZFPEFIM");
request.setTemplateName("Test template");
GetTemplateResponse response = client.getAcsResponse(request);