GetSmsTemplate - 查询模板审核详情(新接口)
申请模板后,通过此接口查询模板审核详情,可查看模板审核状态。
接口说明
-
新接口和原接口变更的公告详情请参见关于短信服务更新签名&模板接口的公告。
-
审核时间:一般情况下,模板提交后,阿里云预计在 2 个小时内审核完成(审核工作时间:周一至周日 9:00~21:00,法定节假日顺延)。
-
如果模板未通过审核,会返回审核失败的原因,请参考短信审核失败的处理建议,调用 UpdateSmsTemplate 接口或在模板管理页面修改短信模板。
-
当前接口是通过模板 Code 查询单个模板的审核详情。 QuerySmsTemplateList 接口可以查询您当前账号下所有模板的模板详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dysms:GetSmsTemplate |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| TemplateCode |
string |
是 |
短信模板 Code。
|
SMS_20375**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
F655A8D5-B967-440B-8683-DAD6FF8DE990 |
| Code |
string |
请求状态码。取值:
|
OK |
| Message |
string |
状态码的描述。 |
OK |
| TemplateName |
string |
短信模板名称。 |
验证码 |
| TemplateCode |
string |
短信模板 Code。 |
SMS_20375**** |
| TemplateContent |
string |
短信模板内容。 |
您正在申请手机注册,验证码为:${code},5分钟内有效! |
| TemplateType |
string |
短信类型。取值:
说明
仅支持企业认证用户申请推广短信和国际/港澳台消息。个人用户与企业用户权益区别详情请参见使用须知。 |
0 |
| TemplateStatus |
string |
模板审核状态。返回值:
|
2 |
| RelatedSignName |
string |
申请模板时,关联的短信签名。 |
阿里云 |
| TemplateTag |
integer |
模板标识。取值:
|
2 |
| OrderId |
string |
工单号。 审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。 |
2003019**** |
| VariableAttribute |
string |
模板变量规则。 模板变量规则详情,请参见示例文档。 |
{"code":"characterWithNumber"} |
| Remark |
string |
短信模板申请说明,是模板审核的参考信息之一。 |
申请验证码模板 |
| CreateDate |
string |
创建短信模板的时间。 |
2024-06-03 10:02:34 |
| AuditInfo |
object |
审核信息。 |
|
| RejectInfo |
string |
审核未通过的原因。 |
模板内容中包含错别字。 |
| AuditDate |
string |
审核时间。 |
2024-06-03 11:20:34 |
| FileUrlList |
object |
||
| FileUrl |
array |
文件资料信息。兼容旧接口创建的信息。 |
|
|
string |
文件信息。 |
//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/data.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D |
|
| MoreDataFileUrlList |
object |
||
| MoreDataFileUrl |
array |
更多资料信息,补充上传业务证明文件或业务截图文件列表。 |
|
|
string |
OSS 上的文件信息。 |
//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/test.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D |
|
| IntlType |
integer |
国际/港澳台模板类型。当 TemplateType 参数返回值为 3 时,此参数取值:
|
0 |
| ApplyScene |
string |
应用场景内容。 |
http://www.aliyun.com/ |
| VendorAuditStatus |
object |
各运营商审核状态,仅数字短信会返回该参数。 key 代表运营商。取值:
value 代表审核状态。取值:
|
{ "MOBILE_VENDOR": 0, "TELCOM_VENDOR": 0, "UNICOM_VENDOR": 0 } |
| SignList |
object |
||
| SignList |
array |
||
|
string |
|||
| SignInfoList |
object |
||
| SignInfoList |
array<object> |
||
|
object |
|||
| SignName |
string |
||
| SaleSkuCode |
string |
||
| SkuName |
string |
||
| SkuStatus |
integer |
示例
正常返回示例
JSON格式
{
"RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
"Code": "OK",
"Message": "OK",
"TemplateName": "验证码",
"TemplateCode": "SMS_20375****",
"TemplateContent": "您正在申请手机注册,验证码为:${code},5分钟内有效!",
"TemplateType": "0",
"TemplateStatus": "2",
"RelatedSignName": "阿里云",
"TemplateTag": 2,
"OrderId": "2003019****",
"VariableAttribute": "{\"code\":\"characterWithNumber\"}\n",
"Remark": "申请验证码模板",
"CreateDate": "2024-06-03 10:02:34",
"AuditInfo": {
"RejectInfo": "模板内容中包含错别字。",
"AuditDate": "2024-06-03 11:20:34\n"
},
"FileUrlList": {
"FileUrl": [
"//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/data.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D"
]
},
"MoreDataFileUrlList": {
"MoreDataFileUrl": [
"//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/test.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D"
]
},
"IntlType": 0,
"ApplyScene": "http://www.aliyun.com/\n",
"VendorAuditStatus": {
"MOBILE_VENDOR": 0,
"TELCOM_VENDOR": 0,
"UNICOM_VENDOR": 0
},
"SignList": {
"SignList": [
""
]
},
"SignInfoList": {
"SignInfoList": [
{
"SignName": "",
"SaleSkuCode": "",
"SkuName": "",
"SkuStatus": 0
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | ForbiddenAction | Access to the account is denied. Please contact the administrator. | |
| 404 | TemplateNotFound | The template does not exist. | 该账号下找不到对应模板。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。