GetSmsTemplate_短信服务_API文档-阿里云OpenAPI开发者门户

接口说明

新接口和原接口变更的公告详情请参见关于短信服务更新签名&模板接口的公告。
审核时间：一般情况下，模板提交后，阿里云预计在 2 个小时内审核完成（审核工作时间：周一至周日 9:00~21:00，法定节假日顺延）。
如果模板未通过审核，会返回审核失败的原因，请参考短信审核失败的处理建议，调用 UpdateSmsTemplate 接口或在模板管理页面修改短信模板。
当前接口是通过模板 Code 查询单个模板的审核详情。 QuerySmsTemplateList 接口可以查询您当前账号下所有模板的模板详情。

流控信息

请求速率为1000/1(s)。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

dysms:GetSmsTemplate	None	全部资源 *	无	无

请求参数

字段名称	字段详情
TemplateCodestring	短信模板 Code。展开详情示例值:SMS_20375****参考取值来源: CreateSmsTemplate UpdateSmsTemplate QuerySmsTemplateList

返回参数

字段名称	字段详情
RequestIdstring	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。示例值:F655A8D5-B967-440B-8683-DAD6FF8DE990
Codestring	请求状态码。取值：展开详情示例值:OK
Messagestring	状态码的描述。示例值:OK
TemplateNamestring	短信模板名称。示例值:验证码
TemplateCodestring	短信模板 Code。示例值:SMS_20375****
TemplateContentstring	短信模板内容。示例值:您正在申请手机注册，验证码为：${code}，5分钟内有效！
TemplateTypestring	短信类型。取值：展开详情示例值:0
TemplateStatusstring	模板审核状态。返回值：展开详情示例值:2
RelatedSignNamestring	申请模板时，关联的短信签名。示例值:阿里云
TemplateTaginteger<int32>	模板标识。取值：展开详情示例值:2
OrderIdstring	工单号。展开详情示例值:2003019****
VariableAttributestring	模板变量规则。展开详情示例值:{"code":"characterWithNumber"}
Remarkstring	短信模板申请说明，是模板审核的参考信息之一。示例值:申请验证码模板
CreateDatestring	创建短信模板的时间。示例值:2024-06-03 10:02:34
AuditInfoobject	审核信息。
FileUrlListobject
MoreDataFileUrlListobject
IntlTypeinteger<int32>	国际/港澳台模板类型。当 TemplateType 参数返回值为 3 时，此参数取值：展开详情示例值:0
ApplyScenestring	应用场景内容。示例值:http://www.aliyun.com/
VendorAuditStatusobject	各运营商审核状态，仅数字短信会返回该参数。展开详情示例值:{ "MOBILE_VENDOR": 0, "TELCOM_VENDOR": 0, "UNICOM_VENDOR": 0 }

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	ForbiddenAction	Access to the account is denied. Please contact the administrator.	诊断
404	TemplateNotFound	The template does not exist.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-03-26	变更返回参数

GetSmsTemplate_短信服务_API文档

接口说明

流控信息

授权信息

请求参数

返回参数

返回示例

错误码

变更历史

相关示例