12590语音验证码
1.开发流程介绍
1.1 语音验证码接口请求方式
支持 GET 和 POST
• Base URL
BaseURL:http://vacapi.7moor.com:3000/OpenService
注意:
1.本接口会对访问 IP 进行验证,请提前报备请求发起的服务器 IP
2.报备 IP 请发邮件到 service@7moor.com
• 业务流程说明
第三方系统通过调用我方http请求接口请求来实现12590验证码语音通知功能
• 请求示例
http://vacapi.7moor.com:3000/OpenService?action=voiceVerifyStandard
&account=N0000000****&exten=151********&verifyCode=1234
• 获取账账户编号
登录对接指南(http://www.7moor.com/interface)→查询账号信息→输入账户名 账户编号:接口需要传的 account 字段
2.语音验证码
2.1 请求参数
属性 | 类型 | 约束 | 说明 | 值 |
action | String | 必选 | 动作名称 | voiceVerifyStandard |
account | String | 必选 | 账户编号 | N00000000*** |
exten | String | 必选 | 接收号码,被叫为座机时需要添加区号;被叫为分机时分机号由’-' 隔开,
如:01052823298-3627 |
186****1234 01052823298 |
verifyCode | String | 必选 | 验证码内容,为数字,不区分大小写,长度 4-8 位 | 256728 |
callbackUrl | String | 可选 | 语音验证码状态通知回调地址(必须符合 URL 规范),7moor 平台将向该 Url 地址 发送呼叫结果通知。 | |
actionID | String | 可选 | 用户用来标识请求的操作,如不传则为随 机码。 | |
playTimes | String | 可选 | 语音验证码播放次数。不传默认1次 |
2.2 请求示例
http://vacapi.7moor.com:3000/OpenService? action=voiceVerifyStandard
&account=N0000000****&exten=151********&verifyCode=1234
2.3 响应包体
属性 | 类型 | 约束 | 说明 | 值 |
statusCode | String | 必选 | 请求状态码,取值 000000(成功), 可参考错误代码。 | 000000(成功) |
callSid | String | 必选 | 一个由 32 个字符组成的唯一电话标 识符 | |
dateCreated | String | 必选 | 电话的创建时间 |
2.4JSON 响应示例
{
"statusCode" : "000000",
"VoiceVerify" : {
"statusCode": "000000",
"dateCreated" : "2016-01-07 15:09:50",
"callsid":"1601071509506408000101160001bf2f"
}
}
3.语音验证码回调通知
3.1 请求地址
POST/respUrl (调用语音验证码接口时的 respUrl 参数)
3.2 请求包体
属性 | 类型 | 约束 | 说明 | 值 |
account | String | 必选 | 账户编号 | N00000000*** |
action | String | 必选 | 表示语音验证码 | VoiceCode |
callSid | String | 必选 | 对应接口返回 callSid 参数,一 路呼叫的唯一标示 | 160107150950640800 0101160001bf2f |
exten | String | 必选 | 外呼号码 | |
status | String | 必选 | 通话状态 | 0 正常通话1 被叫通话未应答
2 外呼失败 |
actionID | String | 必选 | 用户用来标识请求的操作,如不传则为随机码。 | a4a2c080-b50d-11e5818b-03624a863382 |
duration | String | 必选 | 通话时长 | 单位秒 |
3.3 JSON 请求示例
POST【客户充值时传的回调 URL】HTTP/1.1
{
"account": "N00000000***",
"action": "VoiceCode",
"callSid": "1601071509506408000101160001bf2f",
"exten": "186****1234",
"status": "0",
"actionID": "a4a2c080-b50d-11e5-818b-03624a863382",
"duration": "6"
}