1 协议说明
协议 | HTTP POST |
---|---|
编码格式 | UTF8 |
URL | 举例:https://msg.yundashi.com/intf/sendvoiceprompt?sdkappid=xxxxx&random=xxxx |
接口说明 | 给国内用户发语音通知(支持中文、英文字母、数字及组合,内容长度不超过 100 字)。注:sdkappid请填写您在云大师短信官网上申请到的客户编号,random请填成随机数。 |
2 请求包体
包体为json字符串,参数如下:
{
"ext": "",//用户的session内容,云大师server回包中会原样返回,可选字段,不需要就填空。
"playtimes": 2,//播放次数,最多 3 次,默认 2 次 ,
"promptfile": "语音内容文本",
"prompttype": 2,//语音类型,目前固定为 2
"sig": "ecab4881ee80ad3d76bb1da68387428ca752eb885e52621a3129dcf4d9bc4fd4",//app凭证,具体计算方式见下注
"tel": {
"mobile": "13788888888",//手机号码
"nationcode": "86"//国家码
},
"time": 1457336869//unix时间戳,请求发起时间,如果和系统时间相差超过10分钟则会返回失败
}
参数 | 必选 | 类型 | 描述 |
---|---|---|---|
ext | 否 | string | 用户的 session 内容,云大师server 回包中会原样返回 |
promptfile | 是 | string | 通知内容,utf8编码,支持中文英文、数字及组合,需要和语音内容模版相匹配 |
prompttype | 是 | number | 语音类型,目前固定为 2 |
playtimes | 否 | number | 播放次数,最多 3 次,默认 2 次 , |
sig | 是 | string | App 凭证,具体计算方式见下注 |
tel | 是 | object | 电话号码 |
time | 是 | number | 请求发起时间,unix 时间戳(单位:秒),如果和系统时间相差超过 10 分钟则会返回失败 |
- 数组tel元素参数:
参数 | 必选 | 类型 | 描述 |
---|---|---|---|
mobile | 是 | string | 手机号码 |
nationcode | 是 | string | 国家码 |
注:
"sig" 字段根据公式 sha256(appkey=$appkey&random=$random&time=$time&mobile=$mobile)生成 伪代码如下:
string strMobile = "13788888888"; //tel的mobile字段的内容
string strAppKey = "dffdfd6029698a5fdf4"; //sdkappid对应的appkey,需要业务方高度保密
string strRand = "7226249334"; //url中的random字段的值
string strTime = "1457336869"; //unix时间戳
string sig = sha256(appkey=$strAppKey&random=$strRand&time=$strTime&mobile=$strMobile);
3 应答包体
{
"result": 0,//错误码,0 表示成功(计费依据),非 0 表示失败
"errmsg": "OK",//错误消息,result 非 0 时的具体错误信息
"callid": "xxxx",//标识本次发送 id,标识一次下发记录
"ext": ""//用户的 session 内容,云大师server回包中会原样返回
}