语音验证码接口文档

互亿无线语音验证码APIv2.3中国·上海4008808898互亿无线语音验证码APIv2.3接口说明文件标识Ihuyi_VoiceAPI版本编号V2.3发布者上海思锐信息技术有限公司发布日期2012-07-18最新更新2021-12-13

目录255711.概要 382311.1文档说明 3235711.2接口内容 3318981.3提交方式 3273451.4加密方式 327401.5APIID/APIKEY 375902.语音验证码发送 4139342.1接口描述 4150852.2请求地址 4137832.3请求参数 433502.4响应示例 4194122.5响应参数 5114832.6GET请求示例 6127923.发送回执推送 6271933.1接口描述 6271633.2推送参数 7128534.余额查询 8321464.1接口描述 8326874.2请求地址 879864.3请求参数 860884.4响应示例 837314.5响应参数 958174.6GET请求示例 10200035.生成动态密码方式 10143376.常见问题 1128226.1如何实现UNIX时间戳 11238867.语音验证码DEMO 12196788.联系方式 131.概要1.1文档说明本文档主要提供给互亿平台的用户对接接口的使用说明，开发者可以利用ihuyi提供的HTTP接口，调用ihuyi的语音验证码服务。1.2接口内容本文档包含语音验证码发送、余额查询等。1.3提交方式GET/POST1.4加密方式1、采用HTTPS协议提交请求2、通过MD5动态签名方式加密1.5APIID/APIKEY登录用户中心，进入【语音验证码】模块，在【产品总揽】页面右上角，如下图所示：

2.语音验证码发送2.1接口描述通过POST、GET方式进行语音提交，数据编码采用utf-8格式，内容格式为：Content-Type:application/x-www-form-urlencoded，24小时全天发送。2.2请求地址/webservice/voice.php?method=Submit2.3请求参数参数名称参数值描述必填accountAPIID（请登录用户中心【语音验证码】-【产品纵览】查看）是password1、APIKEY（请登录用户中心【语音验证码】-【产品纵览】查看）2、动态密码（生成动态密码方式请看该文档末尾的说明）是mobile接收手机号码，只能提交一个号码是content验证码（4-6位数字）是timeUnix时间戳（10位整型数字，当使用动态密码方式时为必填）否format返回格式（可选值为：xml或json，系统默认为xml）否用户通过http或https提交发送短信请求到服务器后，服务器会返回一串xml格式的字符串，SubmitResult结构说明如下：参数名称类型描述codeint返回值为2时，表示提交成功voiceidstring当提交成功后，此字段为流水号，否则为0msgstring提交结果描述2.4响应示例示例（成功）<?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns=""><code>2</code><msg>提交成功</msg><voiceid>60495654</voiceid></SubmitResult>示例（失败）<?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns=""><code>405</code><msg>用户名或密码不正确</msg><voiceid>0</voiceid></SubmitResult>2.5响应参数codemsg0提交失败2提交成功400非法ip访问401帐号不能为空402密码不能为空403手机号码不能为空4030手机号码已被列入黑名单404语音验证码内容不能为空405用户名或密码不正确4050账号被冻结4051剩余条数不足4052访问ip与备案ip不符406手机格式不正确407短信内容含有敏感字符4070语音验证码内容必须为4-6位数字408您的帐户疑被恶意利用，已被自动冻结，如有疑问请与客服联系2.6GET请求示例/webservice/voice.php?method=Submit&account=APIID&password=APIKEY&mobile=手机号码&content=11253.发送回执推送3.1接口描述用户先提供数据接收地址，然后绑定到互亿无线系统后台，平台会以POST方式实时的将回执信息推送到此地址，内容格式为：Content-Type:application/x-www-form-urlencoded。3.2推送参数参数名称参数值描述code状态值（2成功0失败）msg回执状态说明mobilephone手机号码talktime接听时间（秒）voiceid流水号（对应提交时返回的voiceid）report_time回执时间例：2018-05-2417:46:50注意:成功接收请输出字符“success”（不包含引号）结束推送，否则以接收失败处理。每个回执最多推送3次。每次间隔叠加60秒。code参数说明codemsg2成功0未知错误-1关机-2停机-3暂时无法接通-4正在通话-5空号-6无人接听-8呼入限制-9网络忙-10呼出限制-11线路忙-12用户拒接4.余额查询4.1接口描述通过接口可以方便的查询你的账户语音验证码剩余条数。4.2请求地址/webservice/voice.php?method=GetNum4.3请求参数参数名称参数值描述必填accountAPIID（请登录用户中心【语音验证码】-【产品纵览】查看）是password1、APIKEY（请登录用户中心【语音验证码】-【产品纵览】查看）2、动态密码（生成动态密码方式请看该文档末尾的说明）是timeUnix时间戳（10位整型数字，当使用动态密码方式时为必填）否format返回格式（可选值为：xml或json，系统默认为xml）否用户通过http或https提交帐户余额查询请求到服务器后，服务器会返回一串xml格式的字符串，GetNumResult结构说明如下：参数名称类型描述codeint状态返回值msgstring查询结果描述numstring剩余数量4.4响应示例示例（成功）<?xmlversion="1.0"encoding="utf-8"?><GetNumResultxmlns=""><code>2</code><msg>查询成功</msg><voiceid>856</voiceid></GetNumResult>示例（失败）<?xmlversion="1.0"encoding="utf-8"?><GetNumResultxmlns=""><code>405</code><msg>用户名或密码不正确</msg><num>0</num></GetNumResult>4.5响应参数codemsg2查询成功400非法ip访问401帐号不能为空402密码不能为空405用户名或密码不正确4050账号被冻结4.6GET请求示例/webservice/voice.php?method=GetNum&account=APIID&password=APIKEY5.生成动态密码方式以PHP为例，提交语音验证码的生成方式：$time=time();$password=md5($account.$apikey.$mobile.$content.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手机号：138xxxxxxxx内容：1125time：1451544941结果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx11251451544941');查询剩余条数的生成方式：$time=time();$password=md5($account.$apikey.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手机号：138xxxxxxxxtime：1451544941结果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');Unix时间戳参考地址：/Tools/unixtime.aspx6.常见问题6.1如何实现UNIX时间戳语言代码JAVAStringdate=newjava.text.SimpleDateFormat("dd/MM/yyyyHH:mm:ss").format(newjava.util.Date(Unixtimestamp*1000))Linuxdate-d@UnixtimestampCstrptime(datetime,"%Y-%m-%d%H:%M:%S",&tm_time);unixtime=mktime(&tm_time);C++std::time_tt=std::time(0);DELPHIusesDateUtils;DateTimeToUnix(Now)GOimport"time"cur:=time.Now()timestamp:=cur.UnixNano()/1000000Perl先my$time=Unixtimestamp然后my($sec,$min,$hour,$day,$month,$year)=(localtime($time))[0,1,2,3,4,5,6]PHPdate('r',Unixtimestamp)Node.jsvardate=newDate(time*1000);vartime=date.getTime()/1000;Python先importtime然后time.gmtime(Unixtimestamp)RubyTime.at(Unixtimestamp)SHELLdate+%s//UNIX的时间戳;VBScript/ASPDateAdd("s",Unixtimestamp,"01/01/197000:00:00")VB6DateDiff("s","1970-1-10:0:0",ToUnixTime)易语言时间_到时间戳（）7.语音验证码DEMO语言DEMO地址PHP/demo/voice/php.htmlJAVA/demo/voice/java.htmlASP/demo/voice/asp.htmlASP.NET(C#)/demo/voice/aspx.h