All Products
Search

This Product

    Direct Mail:QueryTemplateByParam

    Document Center

    Direct Mail:QueryTemplateByParam

    Last Updated:Nov 20, 2025

    Performs a paged query to retrieve a list of templates.

    Operation description

    Performs a paged query to retrieve a list of templates.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dm:QueryTemplateByParam

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PageNo

    integer

    No

    The page number. The default value is 1.

    1
    PageSize

    integer

    No

    The number of entries per page. The default value is 20.

    20
    KeyWord

    string

    No

    The keyword of the template name. By default, a paged query is performed for all templates.

    test
    Status

    integer

    No

    This parameter is deprecated. It is retained for historical compatibility.

    Abandoned, historical reasons for compatibility
    FromType

    integer

    No

    This parameter is deprecated. It is retained for historical compatibility.

    Abandoned, historical reasons for compatibility

    Response elements

    Element

    Type

    Description

    Example

    object

    Response

    PageSize

    integer

    The number of entries per page.

    20
    RequestId

    string

    The request ID.

    10Axxxxxxxxxxxx37
    PageNumber

    integer

    The page number.

    1
    TotalCount

    integer

    The total number of entries.

    21
    data

    object

    template

    array<object>

    An array of templates.

    object

    The template information.

    TemplateComment

    string

    The review comments on the template.

    pass
    UtcCreatetime

    integer

    The time when the template was created, in UTC format.

    1661830382
    Smsrejectinfo

    integer

    This parameter is deprecated. It is retained for historical compatibility.

    Abandoned, historical reasons for compatibility
    SmsTemplateCode

    integer

    This parameter is deprecated. It is retained for historical compatibility.

    Abandoned, historical reasons for compatibility
    CreateTime

    string

    The time when the template was created.

    2019-09-29T13:28Z
    TemplateStatus

    string

    The status of the template. Valid values:

    • 0: The template is a draft.

    • 1: The template is pending approval.

    • 2: The template is approved.

    • 3: The template is rejected.

    2
    TemplateType

    integer

    This parameter is deprecated. It is retained for historical compatibility.

    Abandoned, historical reasons for compatibility
    TemplateName

    string

    The template name.

    test
    SmsStatus

    integer

    This parameter is deprecated. It is retained for historical compatibility.

    Abandoned, historical reasons for compatibility
    TemplateId

    string

    The template ID.

    3xxxx8

    Examples

    Success response

    JSON format

    {
  "PageSize": 20,
  "RequestId": "10Axxxxxxxxxxxx37",
  "PageNumber": 1,
  "TotalCount": 21,
  "data": {
    "template": [
      {
        "TemplateComment": "pass",
        "UtcCreatetime": 1661830382,
        "Smsrejectinfo": 0,
        "SmsTemplateCode": 0,
        "CreateTime": "2019-09-29T13:28Z",
        "TemplateStatus": "2",
        "TemplateType": 0,
        "TemplateName": "test",
        "SmsStatus": 0,
        "TemplateId": "3xxxx8"
      }
    ]
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.