语音验证协议
第1章 语音验证码业务
1.1 语音验证码充值提交
1.1.1 入口参数
|
参数名 |
必输 |
|
|
agentid |
Y |
代理商id |
|
key |
Y |
appkey, 从平台界面或管理人员处获取。 |
|
phonenum |
Y |
电话号码 |
|
cont |
Y |
验证码内容 4/6位数字。 |
|
orderno |
Y |
商户订单号，接入方需保证唯一。 |
|
timestamps |
Y |
时间戳 （格式：YYYYMMDDHHIISS） |
|
sign |
Y |
签名 |
|
|
|
|
secretKey : 平台方提供
1.1.2 签名示例
签名内容：
Md5(agentid+key+phonenum+secretKey+cont+orderno+ timestamps)
请求串
http://127.0.0.1/plain/rcvVocSms?agentid=E00000001&key=V0000001&phonenum=15657376123&orderno=10000000000002&cont=1000×tamps=20170713111111&sign=5ee4d5a0feaf2b3c83d4d69a0ada8c5d
secretKey :1a990a8b16a4d2c34ad6710ba1a334ad
signstr=E00000001V0000001156573761231a990a8b16a4d2c34ad6710ba1a334ad10001000000000000220170713111111
最终生成签名sign = c75147888badf7c1c0b3a4c521259253
1.1.3 请求示例
http://ip/plain/rcvVocSms?agentid=E00000001&key=V0000001&phonenum=15657376123&orderno=1000000012&cont=1000×tamps=20170713111111&sign= c75147888badf7c1c0b3a4c521259253
1.1.4 返回参数
|
输入参数名 |
中文名称 |
必输 |
说明 |
|
RetCode |
返回码 |
Y |
00 - 提交成功 其他 - 失败 |
|
RetMsg |
返回信息 |
Y |
错误描述 |
|
BsnsNo |
交易流水号 |
N |
RetCode=00返回 |
|
OrderNo |
订单号 |
N |
RetCode=00返回 |
|
|
|
|
|
1.2 结果推送
客户提供接收推送的URL
1.2.1 请求说明
|
HTTP方法 |
URL |
描述 |
|
POST/GET |
REMOTEURL |
客户提供上行URL |
|
报头 |
描述 |
|
Accept |
application/json |
|
Content-Type |
application/json;charset=utf-8 |
1.2.2 请求参数
|
参数名 |
必输 |
|
|
IUser |
N |
客户端的账号 |
|
IPass |
N |
客户端的密码 |
|
OrderNo |
Y |
客户提交充值请求时的订单号 |
|
BsnsNo |
N |
平台流水号 |
|
PhoneNum |
Y |
单一的手机号码 |
|
RespCd |
Y |
外呼状态:
0：成功接听
|
|
AnwrTime |
Y |
应答时间yyyymmddhhmmss |
|
EndTime |
Y |
结束时间yyyymmddhhmmss |
|
StCallTime |
Y |
开始呼叫时间yyyymmddhhmmss |
|
|
|
|
请求示例：
http://www.onekeylogin.com/AnwrTime=20170727023700&BsnsNo=2017VocSvr072700000008&EndTime=20170727023716&IPass=123456&IUser=test12&OrderNo=1000000012&
PhoneNum=15657376123&RespCd=0&StCallTime=20170727023653
1.2.3 响应消息
|
参数名 |
必备 |
说明 |
|
字符串 |
Y |
返回“0”代表收到。否则服务端会再次推送。 |
|
|