码迷,mamicode.com
首页 > Windows程序 > 详细

速码验证码接码平台API接入示例说明

时间:2017-03-27 19:24:56      阅读:5296      评论:0      收藏:0      [点我收藏+]

标签:验证   传参   号码   返回   question   无法   str   超时   使用   

速码平台API接口示例【通用版】

一、统一说明

  • 接口地址:http://api.eobzz.com/httpApi.do?action=
  • 接口统一编码:UTF-8
  • 接口调用方式: HTTP,支持GET和POST两种方式。
  • GET方式调用实例:http://api.eobzz.com/httpApi.do?action=方法名&参数1=值&参数2=值(具体方法名及参数请参考接口方法)。

 

软件开发者说明:服务器返回no_data时表示系统暂时没有可用号码了,请使用死循环每隔一分钟请求一次手机号,速码平台是不定时加号的。 max_count_disable出现这个提示是因为您获取的号码没有正常处理,每个获取到的号码都必须正确处理(要么获取验证码,要么号码不能用加黑,要么号码收不到短信加黑。getRecvingInfo方法可以查看您当前获取的手机号码 如果接口返回action_parameter_error 表示传入方法名错误或方法不存在。

 

 

 

二、接口方法

1、用户登录

1)方法名:loginIn

2)传入参数:

  • uid:用户名:
  • pwd:密码

3)GET方式调用实例:

  • http://api.eobzz.com/httpApi.do?action=loginIn&uid=用户名&pwd=密码

4)方法调用返回值示例:

1))成功返回:用户名|token(下面所有方法都要用的令牌)

2))失败返回值&说明:

  • login_error用户名密码错误
  • message|速度过快,请稍后再试访问速度过快,建议休眠50毫秒后再试
  • account_is_locked账号被锁定
  • account_is_stoped账号被停用
  • account_is_question_locked账号已关闭
  • account_is_ip_stoped账号ip锁定
  • account_is_FreezeUser账号被冻结

2、获取用户个人信息

1)方法名:getUserInfos

2)传入参数:

  • uid:用户名
  • token=登录时返回的令牌

3)GET方式调用实例:

  • http://api.eobzz.com/httpApi.do?action=getUserInfos&uid=用户名&token=登录时返回的令牌

4)方法调用返回值示例:

1))成功返回:用户名;积分;余额;可同时获取号码数
2))失败返回值&说明:

  • parameter_error传入参数错误
  • not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入uid,token
  • account_is_locked账号被锁定
  • account_is_stoped账号被停用
  • account_is_question_locked账号已关闭
  • account_is_ip_stoped账号ip锁定
  • message|please try again later访问速度过快,建议休眠50毫秒后再试
  • unknow_error未知错误,再次请求就会正确返回

3、获取手机号码

1)方法名:getMobilenum

2)传入参数:

  • pid=项目ID
  • uid=登录用户名
  • token=登录时返回的令牌
  • mobile=指定号码获取(可以不填写该参数,如填入格式不正确则获取新号码)
  • size=获取号码数(可以不填,默认为1,1<=size<=10)
  • province=归属地(省份,例如:广东、北京)
  • province值:广东|辽宁|湖南|内蒙古|浙江|安徽|贵州|西藏|黑龙江|陕西|广西|湖北|福建|山西|江西|海南|江苏|云南|河南|山东|新疆|青海|吉林|河北|宁夏|北京|天津|上海|四川|重庆|甘肃
  • province中文传参时可能产生乱码,最好经过URL转码,(例如:java转码方式 java.net.URLEncoder.encode("广东","UTF-8"))。
  • phoneType=运营商(CMCC(移动)、UNICOM(联通)、TELECOM(电信)) 。

3)GET方式调用实例:

  • http://api.eobzz.com/httpApi.do?action=getMobilenum&pid=项目 ID&uid=用户名&token=&mobile=&size=1

4)归属地、运营商调用实例:

  • http://api.eobzz.com/httpApi.do?action=getMobilenum&pid=项目 ID&uid=用户名&token=&mobile=&size=1&province=广东&phoneType=CMCC

5)方法调用返回值示例:

1))成功返回:手机号码|token

注意:多个号码返回值:手机号;手机号;手机号| token

2))失败返回值&说明:

  • no_data系统暂时没有可用号码了
  • parameter_error传入参数错误
  • not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入uid,token
  • account_is_locked账号被锁定
  • account_is_stoped账号被停用
  • account_is_question_locked账号已关闭
  • account_is_ip_stoped账号ip锁定
  • message|速度过快,请稍后再试访问速度过快,建议休眠50毫秒后再试
  • not_found_project没有找到项目,项目ID不正
  • message|可使用余额不足可使用余额不足
  • max_count_disable已经达到了当前等级可以获取手机号的最大数量,请先处理完您手上的号码再获取新的号码(处理方式:能用的号码就获取验证码,不能用的号码就加黑)
  • unknow_error未知错误,再次请求就会正确返回

4、获取验证码并不再使用本号

1)方法名:getVcodeAndReleaseMobile

2)传入参数:

  • mobile=用getMobilenum方法获取到的手机号
  • token=登录时返回的令牌
  • uid=用户名
  • author_uid=软件开发者用户名(可选, 可得10%的消费分成)

3)GET方式调用实例:

  • http://api.eobzz.com/httpApi.do?action=getVcodeAndReleaseMobile&uid=用户&token=登录时返回的令牌&mobile=获取到的手机号码&author_uid=软件开发者用户名(可选, 可得10%的消费分成)

4)方法调用返回值示例:

1))成功返回:手机号码|验证码短信

2))失败返回值&说明:

  • ?       not_receive还没有接收到验证码,请让程序等待几秒后再次尝试
  • ?       parameter_error传入参数错误
  • ?       not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入uid,token
  • ?       account_is_locked账号被锁定
  • ?       account_is_stoped账号被停用
  • ?       account_is_question_locked账号已关闭
  • ?       account_is_ip_stoped账号ip锁定
  • ?       message|please try again later访问速度过快,建议休眠50毫秒后再试
  • ?       message|可使用余额不足可使用余额不足
  • ?       not_found_moblie没有找到手机号
  • not_found_project没有找到项目,项目ID不正确

5、获取验证码并继续使用本号

1方法名:getVcodeAndHoldMobilenum

2)传入参数:

  • mobile=用getMobilenum方法获取到的手机号
  • uid=用户名
  • token=登录时返回的令牌
  • next_pid=下个要接收的项目ID
  • author_uid=软件开发者用户名(可选, 可得10%的消费分成)

3)GET方式调用实例:

  • http://api.eobzz.com/httpApi.do?action=getVcodeAndHoldMobilenum&uid=用户&token=登录时返回的令牌&mobile=获取到的手机号码&next_pid=下个要接收的项目ID&author_uid=软件开发者用户名(可选, 可得10%的消费分成)

4)方法调用返回值示例:

1))成功返回:发送号码|验证码| token

2))失败返回值&说明:

  • ?       not_receive还没有接收到验证码,请让程序等待几秒后再次尝试
  • parameter_error传入参数错误
  • not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入uid,token
  • account_is_locked账号被锁定
  • account_is_stoped账号被停用
  • account_is_question_locked账号已关闭
  • ?       account_is_ip_stoped账号ip锁定
  • message|please try again later访问速度过快,建议休眠50毫秒后再试
  • message|可使用余额不足可使用余额不足
  • not_found_moblie没有找到手机号
  • not_found_project没有找到项目,项目ID不正确
  • unknow_error未知错误,再次请求就会正确返回

6、加黑无用号码

1)方法名:addIgnoreList

2)传入参数:

  • pid=项目ID
  • mobiles=以,号分隔的手机号列表
  • uid=用户名
  • token=登录时返回的令牌

3)GET方式调用实例:

  • ? http://api.eobzz.com/httpApi.do?action=addIgnoreList&uid=用户名&token=登录时返回的令牌&mobiles=号码1,号码2,号码3&pid=项目ID

4)方法调用返回值示例:

1))成功返回:加黑成功的号码数量

2))失败返回值&说明:

  • ? parameter_error传入参数错误
  • ? not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入uid,token
  • ? account_is_locked账号被锁定
  • ? account_is_stoped账号被停用
  • ? account_is_question_locked账号已关闭
  • ? account_is_ip_stoped账号ip锁定
  • ? unknow_error未知错误,再次请求就会正确返回

7、已获取号码列表

1)方法名:getRecvingInfo

2)传入参数:

  • uid=用户名
  • token=登录时返回的令牌
  • pid=项目ID(pid等于0的时候获取所有号码,pid不等于0的时候获取指定项目号码)

3)GET方式调用实例:

  • http://api.eobzz.com/httpApi.do?action=getRecvingInfo&uid=用户名&pid=项目ID&token=登录时返回的令牌

4)方法调用返回值示例:

1))成功返回: 没有获取号码记录:[ ] 单条:[{"Pid":项目ID,"Recnum":号码,"Timeout":号码超时释放所剩时间,"Start_time":获取号码时间}](*"Timeout"以秒为单位) 多条:[{"Pid":项目ID,"Recnum":号码,"Timeout":号码超时释放所剩时间,"Start_time":获取号码时间},{"Pid":项目ID,"Recnum":号码,"Timeout":号码超时释放所剩时间,"Start_time":获取号码时间},{...}](*"Timeout"以秒为单位)

2))失败返回值说明:

  • ?       parameter_error传入参数错误
  • ?       not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入uid,token
  • ?       account_is_locked账号被锁定
  • ?       account_is_stoped账号被停用
  • ?       account_is_question_locked账号已关闭
  • ?       account_is_ip_stoped账号ip锁定
  • ?       message|please try again later访问速度过快,建议休眠100毫秒后再试
  • ?       not_found_moblie没有找到手机号
  • ?       not_found_project没有找到项目,项目ID不正确
  • ?       message|可使用余额不足可使用余额不足
  • ?       not_send号码已下线,无法发送
  • ?       fail失败
  • unknow_error未知错误,再次请求就会正确返回

 

速码验证码接码平台API接入示例说明

标签:验证   传参   号码   返回   question   无法   str   超时   使用   

原文地址:http://www.cnblogs.com/jiema/p/6628340.html

(0)
(0)
   
举报
评论 一句话评论(0
0条  
登录后才能评论!
© 2014 mamicode.com 版权所有 京ICP备13008772号-2
迷上了代码!