文档中心 > API类目 > 聚石塔API

taobao.jst.sms.template.query (淘宝短信模板查询)

淘宝短信模板查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
query_sms_template_request TopQuerySmsTemplateRequest 可选 查询短信模板的入参
  • └ template_code
  • String
  • 必须
  • SMS_100001
  • 要查询的模板CODE

响应参数

名称 类型 示例值 描述
r_code String template_not_found 错误码
r_success Boolean true 请求成功
module AccessBaseDTO { "success": true, "module": { "templateType": 1, "templateStatus": 1, "reason": "无审批备注", "templateName": "聚石塔测试模板12", "templateContent": "活动快开始了${code}", "templateCode": "SMS_229420004", "createDate": "2021-12-02 21:34:19" } } 返回结果
  • └ template_type
  • Number
  • 1
  • 0--验证码 1--短信通知 2-- 推广短信 3--国际/港澳台消息
  • └ template_status
  • Number
  • 0
  • 0--待审核 1--通过 2--拒绝
  • └ reason
  • String
  • 审核意见
  • 审核意见
  • └ template_name
  • String
  • 测试模板
  • 模板名称
  • └ template_content
  • String
  • 活动快开始了${code}
  • 模板内容
  • └ template_code
  • String
  • SMS_100001
  • 模板CODE
  • └ create_date
  • String
  • 2021-12-02 21:34:19
  • 创建时间
message String 请求失败,模板未找到 错误消息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
JstSmsTemplateQueryRequest req = new JstSmsTemplateQueryRequest();
JstSmsTemplateQueryRequest.TopQuerySmsTemplateRequest obj1 = new JstSmsTemplateQueryRequest.TopQuerySmsTemplateRequest();
obj1.setTemplateCode("SMS_100001");
req.setQuerySmsTemplateRequest(obj1);
JstSmsTemplateQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<jst_sms_template_query_response>
    <r_code>template_not_found</r_code>
    <r_success>true</r_success>
    <module>
        <template_type>1</template_type>
        <template_status>0</template_status>
        <reason>审核意见</reason>
        <template_name>测试模板</template_name>
        <template_content>活动快开始了${code}</template_content>
        <template_code>SMS_100001</template_code>
        <create_date>2021-12-02 21:34:19</create_date>
    </module>
    <message>请求失败,模板未找到</message>
</jst_sms_template_query_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部