接口描述
功能描述
给中国大陆地区用户发送指定模板的语音通知。
URL 示例
POST https://cloud.tim.qq.com/v5/tlsvoicesvr/sendtvoice?sdkappid=xxxxx&random=xxxx
其中,sdkappid
请填写您在 语音消息控制台 添加应用后生成的实际 SDK AppID,random
请填写成随机数字。
请求参数
{
"tpl_id": 4356,
"params": [ "7652" ],
"playtimes": 2,
"sig": "ecab4881ee80ad3d76bb1da68387428ca752eb885e52621a3129dcf4d9bc4fd4",
"tel": {
"mobile": "13788888888",
"nationcode": "86"
},
"time": 1457336869,
"ext": ""
}
参数 | 必选 | 类型 | 描述 |
---|---|---|---|
tpl_id | 是 | number | 模板 ID,在控制台审核通过的模板 ID |
params | 是 | array | 模板参数,若模板没有参数,请提供为空数组 若使用数字则默认按照个十百千万进行播报,可通过在数字前添加英文逗号(,)改变播报方式,例如 5,6,7,8 |
playtimes | 否 | number | 播放次数,可选,最多3次,默认2次 |
sig | 是 | string | App 凭证,具体计算方式请参见下方说明 |
tel | 是 | object | 电话号码,详细参数说明请参见下方表格 |
time | 是 | number | 请求发起时间,UNIX 时间戳,如果和系统时间相差超过10分钟则会返回失败 |
ext | 否 | string | 用户的 session 内容,腾讯 server 回包中会原样返回 |
参数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;
响应参数
{
"result": 0,
"errmsg": "ok",
"callid": "9277cf828943eb70b3cea31890008ad0",
"ext": ""
}
参数 | 必选 | 类型 | 描述 |
---|---|---|---|
result | 是 | number | 错误码,0 表示成功(计费依据),非 0 表示失败 |
errmsg | 是 | string | 错误消息,result 非0时的具体错误信息 |
callid | 否 | string | 标识本次发送 ID,标识一次下发记录 |
ext | 否 | string | 用户的 session 内容,腾讯 server 回包中会原样返回 |
Demo
腾讯云语音消息为您提供了 Java SDK、PHP SDK、Python SDK、Node.js SDK 和 C# SDK 供您参考,欢迎查阅。