All Products
Search

This Product

    Direct Mail:DescTemplate

    Document Center

    Direct Mail:DescTemplate

    Last Updated:Dec 11, 2025

    Views the information about a template.

    Operation description

    You can call this operation to view the information about a template.

    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:DescTemplate

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TemplateId

    integer

    Yes

    The template ID.

    3xxxx2
    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

    SmsContent

    string

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

    Abandoned, historical reasons for compatibility
    RequestId

    string

    The request ID.

    95xxx5F
    Remark

    string

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

    Abandoned, historical reasons for compatibility
    SmsType

    string

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

    Abandoned, historical reasons for compatibility
    CreateTime

    string

    The time when the template was created.

    2025-11-14T13:28Z
    TemplateSubject

    string

    The template subject, which is used to create the email subject.

    test
    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
    TemplateNickName

    string

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

    Abandoned, historical reasons for compatibility
    TemplateType

    string

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

    Abandoned, historical reasons for compatibility
    TemplateName

    string

    The template name.

    test1
    TemplateText

    string

    The template content.

    1

    Examples

    Success response

    JSON format

    {
  "SmsContent": "Abandoned, historical reasons for compatibility",
  "RequestId": "95xxx5F",
  "Remark": "Abandoned, historical reasons for compatibility",
  "SmsType": "Abandoned, historical reasons for compatibility",
  "CreateTime": "2025-11-14T13:28Z",
  "TemplateSubject": "test",
  "TemplateStatus": "2",
  "TemplateNickName": "Abandoned, historical reasons for compatibility",
  "TemplateType": "Abandoned, historical reasons for compatibility",
  "TemplateName": "test1",
  "TemplateText": "
1"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.