DocsICP FilingConsole
Documentation

QueryRCSTemplate - 查询模板详情

Updated at:
Copy as MD
Product
My Favorites

查询5G消息模板的详细信息。

接口说明

前提条件

已通过 CreateRCSTemplate 接口创建 5G 消息模板。

使用说明

通过模板 Code 查询模板的完整信息，包括模板内容、变量规则、悬浮菜单、审核状态和有效期状态。

QPS 限制

本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用将会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dysms:QueryRCSTemplate

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
TemplateCode

string

是

模板 Code。通过 CreateRCSTemplate 接口获取。

RCS_SMS_10001052

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

访问被拒绝时返回的详细信息。

None
RequestId

string

本次请求的 ID。

A90E4451-FED7-49D2-87C8-00700A8C4D0D
Message

string

状态码的描述。

OK
Data

object

返回数据，具体请参见下方 Data 返回数据结构说明。

Code

string

请求状态码。返回 OK 代表请求成功。

OK
Success

boolean

是否调用成功。

  • true：调用成功。

  • false：调用失败。

true

Data 返回数据结构说明

字段类型描述示例
TemplateCodeString模板 CodeRCS_SMS_10001052
TemplateNameString模板名称短信阈值告警模版
RelatedSignNamesString短信签名名称，若有多个签名，用英文逗号分隔阿里云,阿里云富媒体
TemplateTypeInteger短信类型。取值：0=验证码，1=短信通知，2=推广短信。0
TemplateFormatString模板类型。取值：PLAIN_TEXT=纯文本模板，RICH_MEDIA=富媒体模板。PLAIN_TEXT
TemplateContentString模板内容尊敬的用户${username}，您的账号${account}今日已达到发送量上限。
TemplateRuleString模板变量规则，JSON 格式见下方返回示例
TemplateMenuString悬浮菜单，JSON 格式，以 suggestions 为根字段见下方返回示例
TemplateAvailableStatusString模板可用状态，按签名和运营商分别返回，JSON 格式。carrier（运营商）取值：1=移动，2=联通，3=电信；availableStatus（审核状态）取值：1=审核中，2=审核成功，3=审核失败。见下方返回示例
TemplateCreateTimeString创建时间2026-01-01 00:00:00

返回示例

{
  "AccessDeniedDetail": "None",
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
  "Message": "OK",
  "Code": "OK",
  "Success": true,
  "Data": {
    "TemplateCode": "RCS_SMS_10001052",
    "TemplateName": "短信阈值告警模版",
    "RelatedSignNames": "阿里云,阿里云富媒体",
    "TemplateType": 0,
    "TemplateFormat": "PLAIN_TEXT",
    "TemplateContent": "尊敬的用户${username}，您的账号${account}今日已达到发送量上限。",
    "TemplateRule": "{\"username\":{\"type\":\"string\",\"description\":\"用户名\",\"maxLength\":20},\"account\":{\"type\":\"string\",\"description\":\"账号\"}}",
    "TemplateMenu": "{\"suggestions\":[{\"action\":{\"urlAction\":{\"openUrl\":{\"url\":\"https://www.aliyun.com\"}}},\"actionText\":\"了解更多\"}]}",
    "TemplateAvailableStatus": "{\"阿里云\":{\"1\":\"2\",\"2\":\"2\",\"3\":\"3\"},\"阿里云富媒体\":{\"1\":\"1\",\"2\":\"2\",\"3\":\"3\"}}",
    "TemplateCreateTime": "2026-01-01 00:00:00"
  }
}

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
  "Message": "OK",
  "Data": {
    "test": "test",
    "test2": 1
  },
  "Code": "OK",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。