拉取短信状态

最近更新时间:2019-12-17 10:14:12

我的收藏

接口描述

功能描述

拉取短信状态(下发状态,短信回复等)。
拉取过的内容不会再重复返回,可以理解为消息队列机制。
此功能需要联系 sms helper 开通。

URL 示例

POST https://yun.tim.qq.com/v5/tlssmssvr/pullstatus?sdkappid=xxxxx&random=xxxx
其中,sdkappid请填写您在 短信控制台 添加应用后生成的实际 SDK AppID,random请填写成随机数。

请求参数

请求参数如下表所示。
参数
必选
类型
描述
max
number
拉取最大条数,最多100。
sig
string
App 凭证,具体计算方式请参见下方说明。
time
number
请求发起时间,UNIX 时间戳(单位:秒),如果和系统时间相差超过10分钟则会返回失败。
type
number
拉取类型,Enum{0: 短信下发状态, 1: 短信回复}。
说明:
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;
请求示例:
{
"max": 10,
"sig": "c13e54f047ed75e821e698730c72d030dc30e5b510b3f8a0fb6fb7605283d7df",
"time": 1457336869,
"type": 1
}

响应参数

响应参数如下表所示。
参数
必选
类型
描述
count
number
result 为0时有效,返回的信息条数。
data
array
具体内容请参见 短信下发状态通知短信回复
errmsg
string
result 非0时的具体错误信息。
result
number
错误码,0表示成功(计费依据),非0表示失败。
响应示例:
{
"count": 3,
"data": [],
"errmsg": "ok",
"result": 0
}

DEMO

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