指定模板单发短信

最近更新时间:2021-03-01 14:39:36

我的收藏

接口描述

功能描述

给用户发短信验证码、通知类短信或营销短信。

URL 示例

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

请求参数

请求参数说明如下表所示。
参数
必选
类型
描述
ext
string
用户的 session 内容,腾讯 server 回包中会原样返回,可选字段,不需要时设置为空。
extend
string
短信码号扩展号,格式为纯数字串,其他格式无效。默认没有开通,如需开通请联系 sms helper
params
array
模板参数,该字段需结合 tpl_id 字段使用。若模板没有自定义变量参数,请设置为空数组。
sig
string
App 凭证,具体计算方式请参见下方 说明
sign
string
短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名。
签名信息可登录 短信控制台 查看。
tel
object
国际电话号码,格式依据 e.164 标准为:[国家(或地区)码][手机号] ,例如8613711112222, 其中86为国家码,13711112222为手机号。
time
number
请求发起时间,UNIX 时间戳(单位:秒),如果和系统时间相差超过10分钟则会返回失败。
tpl_id
number
模板 ID,必须填写已审核通过的模板 ID。
模板信息可登录 短信控制台 查看。
参数 tel
参数
必选
类型
描述
mobile
string
手机号码
nationcode
string
国家(或地区)码
说明:

sig
字段:根据公式 sha256(appkey=$appkey&random=$random&time=$time&mobile=$mobile)生成,其伪代码如下:
string strMobile = "13788888888"; //tel 的 mobile 字段的内容
string strAppKey = "5f03a35d00ee52a21327ab048186a2c4"; //sdkappid 对应的 appkey,需要业务方高度保密
string strRand = "7226249334"; //URL 中的 random 字段的值
string strTime = "1457336869"; //UNIX 时间戳
string sig = sha256(appkey=5f03a35d00ee52a21327ab048186a2c4&random=7226249334&time=1457336869&mobile=13788888888)
= ecab4881ee80ad3d76bb1da68387428ca752eb885e52621a3129dcf4d9bc4fd4;
请求示例:
{
"ext": "",
"extend": "",
"params": [
"验证码",
"1234",
"4"
],
"sig": "ecab4881ee80ad3d76bb1da68387428ca752eb885e52621a3129dcf4d9bc4fd4",
"sign": "腾讯云",
"tel": {
"mobile": "13788888888",
"nationcode": "86"
},
"time": 1457336869,
"tpl_id": 19
}

响应参数

响应参数说明如下表所示。
参数
必选
类型
描述
result
number
错误码,0表示成功(计费依据),非0表示失败,更多详情请参见 错误码
errmsg
string
错误消息,result 非0时的具体错误信息。
ext
string
用户的 session 内容,腾讯 server 回包中会原样返回。
fee
number
sid
string
本次发送标识 ID,标识一次短信下发记录。
响应示例:
{
"result": 0,
"errmsg": "OK",
"ext": "",
"fee": 1,
"sid": "xxxxxxx"
}

Demo

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