Skip to Content
短信服务 USMS查询短信模板申请状态 - QueryUSMSTemplate

查询短信模板申请状态 - QueryUSMSTemplate

简介

调用接口QueryUSMSTemplate查询短信模板申请状态

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称,当前 API 为 QueryUSMSTemplateYes
PublicKeystring用户公钥,可从 控制台 获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名,参见 签名算法Yes

请求参数

参数名类型描述信息必填
ProjectIdstring项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口Yes
TemplateIdstring模板IDYes

响应字段

字段名类型描述信息必填
RetCodeint返回状态码,为 0 则为成功返回,非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息,当 RetCode 非 0 时提供详细的描述信息No
DataOutTemplate短信模板明细信息,各字段说明详见OutTemplateNo

数据模型

OutTemplate

字段名类型描述信息必填
TemplateIdstring短信模板IDYes
Purposeint模板类型,选项:1-验证码类 2-通知类 3-会员推广类Yes
TemplateNamestring短信模板名称Yes
Templatestring短信模板内容Yes
UnsubscribeInfostring退订信息;一般填写方式“回T退订”,当purpose为3(也即会员推广类)时,为必填项Yes
Statusint短信模板状态;状态说明:0-待审核,1-审核中,2-审核通过,3-审核未通过,4-被禁用Yes
Remarkstring模板说明Yes
ErrDescstring审核失败原因Yes
CreateTimeint创建时间Yes
Instructionstring模板变量属性说明No

示例

请求示例

https://api.an-link.com/?Action=QueryUSMSTemplate &ProjectId=pro-xxxxx &TemplateId=UTA190715D9108C

响应示例

{ "Action": "QueryUSMSTemplateResponse", "Data": { "CreateTime": 1566783067, "ErrDesc": "", "Status": 2, "Template": "您的验证码为{1},请在{2}分钟内使用,勿透露给他人。", "TemplateId": "UTA190715D9108C", "TemplateName": "验证码模板01" }, "Message": "", "RetCode": 0 }