语音验证接口文档

接口描述 / api错误代码 / 开发语言代码示例 / 注意事项 /

语音验证文档

接口列表

地址 描述
http://voice-api.luosimao.com/v1/verify.[json|xml] 语音验证码
http://voice-api.luosimao.com/v1/status.[json|xml] 账户信息(余额)

 

编码

统一使用 UTF-8 编码,请确保您的文件编码及传入参数的格式

 

接口通用信息

验证方式

Luosimao使用 HTTP Basic Auth 方式进行身份验证,使用api作为验证用户名,API key是验证密码,在管理中心->语音->语音验证接口下查看。

 

验证示例
curl --user api:key-3ax6xnjp29jd6fds4gc373sgvjxteol0

 

返回格式

luosimao api 支持xml、json格式的返回结果,请求时使用不同后缀名即可

不同返回格式请求url示例
json返回:
http://voice-api.luosimao.com/v1/verify.json


xml返回:
http://voice-api.luosimao.com/v1/verify.xml

 

 

API key的获取

登录后进入管理中心,在语音 ->语音验证 下可查看自己的短信API KEY,并可进行更换

 

发送语音验证码

接口地址
http://voice-api.luosimao.com/v1/verify.[json|xml]

 

HTTP请求方式

POST

 

请求参数
名称 类型 是否必须 示例值 描述
mobile String 13761428268 目标手机号码
code String 4910 验证码,支持4-6位数字验证码,推荐4位

 

返回结果
名称 类型 是否必须 示例值 描述
error Number 0 错误码
msg String ok 错误码描述
batch_id String 03-B881E50E-25A3-09CA-4CA4-E251C7E7BE15 发送的ID

 

返回示例
json格式:

{"error":0,"msg":"ok"}

xml格式:

<response>
<error>-10</error>
<msg>Auth failed.</msg>
</response>

 

错误码
错误码 错误描述 解决方案
-10 验证信息失败 检查api key是否和各种中心内的一致,调用传入是否正确
-20 余额不足 进入个人中心购买充值
-30 验证码内容为空 检查调用传入参数:code
-40 错误的手机号 检查手机号是否正确

 

查询余额

接口地址
http://voice-api.luosimao.com/v1/status.[json|xml]

 

HTTP请求方式

GET

 

请求参数

 

返回结果
名称 类型 示例值 描述
error Number 0 错误码
deposit Number 20 账户余额

 

错误码
错误码 错误描述 解决方案
-10 验证信息失败 检查api key是否和管理中心内的一致,调用传入是否正确

 

状态推送

 

语音验证码采用接口主动推送的形式进行获取,需要用户提供一个接收接口,呼叫的具体信息会包含在请求中

{REC_URL}?batch_id=03-B881E50E-25A3-09CA-4CA4-E251C7E7BE15&status=success

 

具体含义

 

参数 描述
REC_URL 用户设置的状态接收接口,须以http或https开头,eg.http://baidu.com
batch_id 语音验证发送批次,请求send接口成功时会返回,用户发送时需做记录
status success:接通,failed:未接通
code 接通状态的code,外呼成功为1,外呼失败为0 
outmsg 外呼状态消息,常见消息:408无人接听,480:用户主动挂断、关机、停机、不在服务区等
call_time 外呼开始时间
end_time 外呼结束时间

 

 

语音验证业务流程