QueryRCSTemplate - 查询模板详情-短信服务(SMS)-阿里云帮助中心

接口说明

前提条件

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

使用说明

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

QPS 限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
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 返回数据结构说明

Data 为模板详情数据，包含以下字段：

字段	类型	描述	示例
TemplateCode	String	模板 Code	RCS_SMS_10001052
TemplateName	String	模板名称	短信阈值告警模版
RelatedSignNames	String	短信签名名称，若有多个签名，用英文逗号分隔	阿里云,阿里云富媒体
TemplateType	Integer	短信类型。取值： - 0：验证码。 - 1：短信通知。 - 2：推广短信。	0
TemplateFormat	String	模板类型。取值： - PLAIN_TEXT：纯文本模板。 - RICH_MEDIA：富媒体模板。	PLAIN_TEXT
TemplateContent	String	模板内容	尊敬的用户${username}，您的账号${account}今日已达到发送量上限。
TemplateRule	String	模板变量规则，JSON 格式	见下方返回示例
TemplateMenu	String	悬浮菜单，JSON 格式	见下方返回示例
TemplateAvailableStatus	String	模板可用状态，按签名和运营商分别返回，JSON 格式。 carrier 取值： - 1：移动。 - 2：联通。 - 3：电信。 availableStatus 取值： - 1：审核中。 - 2：审核成功。 - 3：审核失败。	见下方返回示例
TemplateExpireStatus	Integer	模板有效期状态。取值： - 0：未过期。 - 1：已过期。文本类型模板有效期均为未过期。	0
TemplateCreateTime	String	创建时间	2026-01-01 00:00:00
TemplateExpireTime	String	过期时间。文本类型模板过期时间为空，代表永久有效	2026-01-01 00:00:00

返回示例

{
  "Code": "OK",
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
  "Success": true,
  "Data": {
    "TemplateCode": "RCS_SMS_10001052",
    "TemplateName": "短信阈值告警模版",
    "RelatedSignNames": "阿里云,阿里云富媒体",
    "TemplateType": 0,
    "TemplateFormat": "PLAIN_TEXT",
    "TemplateContent": "尊敬的用户${username}，您的账号${account}今日已达到发送量上限。",
    "TemplateRule": "{\"username\":\"ANY\",\"account\":\"ANY\"}",
    "TemplateMenu": "[{\"action\":{\"dialerAction\":{\"dialPhoneNumber\":{\"phoneNumber\":\"+8617928222350\"}},\"displayText\":\"Call a phone number\",\"postback\":{\"data\":\"set_by_chatbot_open_dialer\"}}}]",
    "TemplateAvailableStatus": "[{\"signName\":\"阿里云\",\"carrier\":1,\"availableStatus\":1},{\"signName\":\"阿里云\",\"carrier\":2,\"availableStatus\":2}]",
    "TemplateExpireStatus": 0,
    "TemplateCreateTime": "2026-01-01 00:00:00",
    "TemplateExpireTime": ""
  }
}

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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