文档中心 短信 API 文档 模板API 短信模板状态查询

短信模板状态查询

最近更新时间:2019-04-30 10:13:57

接口描述

功能描述

查询申请的短信(或语音)模板状态。

URL 示例

POST https://yun.tim.qq.com/v5/tlssmssvr/get_template?sdkappid=xxxxx&random=xxxx
:sdkappid 请填写您在腾讯云上申请到的,random 请填成随机数。

请求参数

  • 指定模板 ID 拉取方式:

    {
      "sig": "c13e54f047ed75e821e698730c72d030dc30e5b510b3f8a0fb6fb7605283d7df",
      "time": 1457336869,
      "tpl_id": [123, 124]
    }
  • 分页全量拉取方式:

    {
      "sig": "c13e54f047ed75e821e698730c72d030dc30e5b510b3f8a0fb6fb7605283d7df",
      "time": 1457336869,
      "tpl_page": {
          "max": 10,
          "offset": 0
      }
    }
参数 必选 类型 描述
sig string App 凭证,具体计算方式见下注
time number 请求发起时间,UNIX 时间戳,如果和系统时间相差超过10分钟则会返回失败
tpl_id array 待查询的模板 ID 数组,与 tpl_page 字段不能同时出现
tpl_page object 分页查询全量模版信息,与 tpl_id 字段不能同时出现(应答包的 total 字段为模版总条数)
  • 参数tpl_page
参数 必选 类型 描述
max number 一次拉取的条数,最多50
offset number 拉取的偏移量,初始为0,如果要多次拉取,需赋值为上一次的 offset 与 max 字段的和


"sig" 字段根据公式 sha256(appkey=$appkey&random=$random&time=$time)生成,其伪代码如下:

string strAppkey = "5f03a35d00ee52a21327ab048186a2c4"; //sdkappid 对应的 appkey,需要业务方高度保密
string strRand = "7226249334"; //URL 中的 random 字段的值
string strTime = "1457336869"; //UNIX 时间戳
string sig = sha256(appkey=5f03a35d00ee52a21327ab048186a2c4&random=7226249334&time=1457336869)
           = c13e54f047ed75e821e698730c72d030dc30e5b510b3f8a0fb6fb7605283d7df;

响应参数

{
    "result": 0, 
    "errmsg": "", 
    "total": 10, 
    "count": 1, 
    "data": [
        {
            "id": 123, 
            "international": 0, 
            "reply": "xxxxx", 
            "status": 0, 
            "text": "xxxxx", 
            "type": 0, 
            "title": "xxxxx", 
            "apply_time": "xxxxx", 
            "reply_time": "xxxxx"
        }
    ]
}
参数 必选 类型 描述
result number 错误码,0表示成功(计费依据),非0表示失败
errmsg string 错误消息,result 非0时的具体错误信息
total number 应用的模版总数,result 为0时有效,分页全量拉取时才有该参数
count number 返回的信息条数,result 为0时有效,信息内容在 data 字段中
data array 详细数据

数组data元素参数:

参数 必选 类型 描述
id number 模板 ID
international number 0表示国内短信,1表示海外短信,默认为0
status number 模板状态 Enum{0:已通过, 1:待审核, 2:已拒绝}
reply string 审批信息,如果 status 为 2,会说明拒绝原因
text string 模板内容
type number 短信类型,Enum{0:普通短信, 1:营销短信}
title string 模板名称
apply_time string 申请时间
reply_time string 审核时间

DEMO

腾讯云短信服务为您提供了 Java SDKPHP SDKPython SDKNode.js SDKC# SDK 供您参考,欢迎查阅。