手机验证码自动接收(y码)系统API说明
•系统API的说明
接口地址:/?action=
接口统一编码:UTF-8
接口调用方式:HTTP,支持GET和POST两种方式。
接口调用时间间隔:50毫秒。如果低于50毫秒会提示"message|pleatryagain
later"
GET调用方法:/?action=方法名&参数1=值&参数
2=值(具体方法名及参数请参考接口方法)
注意:
服务器返回no_data时表示系统暂时没有可用号码了,请使用死循环每隔一分
钟请求一次手机号,Y码平台是不定时加号的。
max_count_disable出现这个提示是因为您获取的号码以达到上限,每个获取到
的号码都必须正确处理(要么调用ReleaMobile释放号码退出任务,要么获取
验证码,要么号码不能用加黑,要么号码收不到短信加黑。getRecvingInfo方法
可以查看您当前获取的手机号码
如果接口返回action_parameter_error表示传入方法名错误或方法不存在。
•用户登录
[方法名]loginIn
传入参数:
:用户名
:密码
GET方式调用实例:/?action=loginIn&uid=
用户名&pwd=密码
方法调用返回值示例:
1.成功返回:用户名|token(下面所有方法都要用的令牌)
2.失败返回值说明:
返回值说明
login_error用户名密码错误
message|pleatryagainlater访问速度过快,建议休眠50毫秒后再试
account_is_locked账号被锁定
login_error用户名密码错误
•获取用户个人信息
[方法名]getUrInfos
传入参数:
=用户名
=登录时返回的令牌
GET方式调用实例:
/?action=getUrInfos&uid=用户名
&token=登录时返回的令牌
方法调用返回值示例:
1.成功返回:用户名;积分;余额;可同时获取号码数
2.失败返回值说明
返回值说明
parameter_error传入参数错误
not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入u
message|pleatryagainlater访问速度过快,建议休眠50毫秒后再试
account_is_locked账号被锁定
unknow_error未知错误,再次请求就会正确返回
•获取手机号码
[方法名]getMobilenum
说明:项目ID请登录Y码官网,查看项目管理获得
传入参数:
=项目ID
=登录用户名
=登录时返回的令牌
=是否锁定号码(可以不填写该参数,"1"为锁定。同一个号码接多条短信
以上可锁定,以便用已获取的号码来重复接收短信)
=获取号码数(可以不填,默认为1,1<=size<=10)
=指定号码获取(可以不填写该参数)
=指定运营商(1:电信2:移动3:联通)(可以不填写该参数)
GET方式调用实例:
/?action=getMobilenum&pid=项目
ID&uid=用户名&token=&size=1
方法调用返回值示例:
1.成功返回:手机号码|token注意:多个号码返回值:手机号;手机号;手机号|
token
2.失败返回值说明:
返回值说明
no_data系统暂时没有可用号码了
max_count_disable已达到用户可获取号码上限,可通过调用ReleaMobile方
parameter_error传入参数错误
not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入u
message|pleatryagainlater访问速度过快,建议休眠50毫秒后再试
account_is_locked账号被锁定
mobile_notexists指定的号码不存在
mobile_busy指定的号码繁忙
unknow_error未知错误,再次请求就会正确返回
•释放已获取的手机号码
[方法名]ReleaMobile
说明:此方法可以释放用户获取的所有号码,并终止进行中的任务
传入参数:
=用户名
=登录时返回的令牌
=已获取到的手机号(仅限单个号码),可不填,不填就释放所有号码
GET方式调用实例:
/?action=ReleaMobile&uid=用户名
&token=登录时返回的令牌
方法调用返回值示例:
1.成功返回:OK
2.失败返回值说明
返回值说明
parameter_error传入参数错误
not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入u
message|pleatryagainlater访问速度过快,建议休眠50毫秒后再试
account_is_locked账号被锁定
unknow_error未知错误,再次请求就会正确返回
•获取验证码并不再使用本号
[方法名]getVcodeAndReleaMobile
说明:
1.使用该方法获得验证码后,系统自动加黑该号码
2.因部分短信可能延迟,所以建议该方法每5秒调用一次,调用100秒(可增
加获取成功率)
传入参数:
=用getMobilenum方法获取到的手机号
=登录时返回的令牌
=用户名
=项目ID
_uid=开发者用户名(可选,传入此参数必须是注册类型为软件开发者的用
户名,在获取验证码时传入软件开发者用户名,则按本次消费金额的10%奖励给
软件开发者)
GET方式调用实例:
/?action=getVcodeAndReleaMobile&ui
d=用户&token=登录时返回的令牌&pid=项目ID&mobile=获取到的手机号
码
方法调用返回值示例:
1.成功返回:手机号码|验证码短信
2.失败返回值说明:
返回值说明
not_receive还没有接收到验证码,请让程序等待几秒后再次尝试
parameter_error传入参数错误
not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入u
message|pleatryagainlater访问速度过快,建议休眠50毫秒后再试
account_is_locked账号被锁定
unknow_error未知错误,再次请求就会正确返回
•获取验证码并继续使用本号
[方法名]getVcodeAndHoldMobilenum
说明:
1.使用该方法获得验证码后,如果这个号码可以多少次使用,下次还会获取
2.因部分短信可能延迟,所以建议该方法每5秒调用一次,调用100秒(可增
加获取成功率)
传入参数:
=用getMobilenum方法获取到的手机号
=登录时返回的令牌
=用户名
=项目ID
_uid=开发者用户名(可选,传入此参数必须是注册类型为软件开发者的用
户名,在获取验证码时传入软件开发者用户名,则按本次消费金额的10%奖励给
软件开发者)
GET方式调用实例:
/?action=getVcodeAndHoldMobilenum&u
id=用户&token=登录时返回的令牌&pid=项目ID&mobile=获取到的手机号
码
方法调用返回值示例:
1.成功返回:手机号码|验证码短信
2.失败返回值说明:
返回值说明
not_receive还没有接收到验证码,请让程序等待几秒后再次尝试
parameter_error传入参数错误
not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入u
message|pleatryagainlater访问速度过快,建议休眠50毫秒后再试
account_is_locked账号被锁定
unknow_error未知错误,再次请求就会正确返回
•加黑无用号码
[方法名]addIgnoreList
说明:该方法使用于
1.无法注册的手机号码(对方网站提示不可用)
2.超过100秒都无法获取短信的手机号码
3.调用getVcodeAndHoldMobilenum方法使用结束后的号码
传入参数:
=项目ID
s=以,号分隔的手机号列表
=用户名
=登录时返回的令牌
GET方式调用实例:
/?action=addIgnoreList&uid=用户名
&token=登录时返回的令牌&mobiles=号码1,号码2,号码3&pid=项目ID
方法调用返回值示例:
1.成功返回:加黑成功的号码数量
2.失败返回值说明:
返回值说明
parameter_error传入参数错误
not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入u
message|pleatryagainlater访问速度过快,建议休眠50毫秒后再试
account_is_locked账号被锁定
unknow_error未知错误,再次请求就会正确返回
•已获取号码列表
getRecvingInfo
数:
用户名
n=登录时返回的令牌
项目ID(pid等于0的时候获取所有号码,pid不等于0的时候获取指定项目号码)
式调用实例:/?action=getRecvingInfo&uid=用户名&pid=项目ID&token=登录
用返回值示例:
返回:
取号码记录:[]
"Pid":项目ID,"Recnum":号码,"Timeout":号码超时释放所剩时间,"Start_time":获取号码时间}](*"Timeout"以秒为
"Pid":项目ID,"Recnum":号码,"Timeout":号码超时释放所剩时间,"Start_time":获取号码时间},{"Pid":项目ID,"Rec
meout":号码超时释放所剩时间,"Start_time":获取号码时间},{...}](*"Timeout"以秒为单位)
返回值说明:
说明
ter_error传入参数错误
in没有登录,在没有登录下去访问需要登录的资源,忘记传入uid,token
e|pleatryagainlater访问速度过快,建议休眠50毫秒后再试
_is_locked账号被锁定
_error未知错误,再次请求就会正确返回
•发短信
[方法名]ndSms
说明:调用ndSms方法后,通过getSmsStatus方法检查短信发送状态
传入参数:
=项目ID
=用getMobilenum方法获取到的手机号
=用户名
=登录时返回的令牌
=接收号码,必须是项目指定的接收号码
t=短信内容
_uid=开发者用户名(可选,传入此参数必须是注册类型为软件开发者的用
户名,在获取验证码时传入软件开发者用户名,则按本次消费金额的10%奖励给
软件开发者)
GET方式调用实例:
/?action=ndSms&uid=用户名&token=登
录时返回的令牌&pid=项目ID&mobile=获取的手机号&recv=短信接收号码
&content=短信内容&author_uid=开发者用户名(可选)
方法调用返回值示例:
1.成功返回:OK
2.失败返回值说明:
返回值说明
parameter_error传入参数错误
not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入u
message|pleatryagainlater访问速度过快,建议休眠50毫秒后再试
account_is_locked账号被锁定
Recv_Err短信接收号码不在项目允许的范围内
Task_NotExists任务不存在,可能超时被释放,请重新获取号码
message|此项目不支持发送短信此项目不支持发送短信
unknow_error未知错误,再次请求就会正确返回
•获取短信发送状态
[方法名]getSmsStatus
说明:该方法使用于发送短信后,检查短信是否发送成功
传入参数:
=项目ID
=用getMobilenum方法获取到的手机号
=用户名
=登录时返回的令牌
GET方式调用实例:
/?action=getSmsStatus&uid=用户名
&token=登录时返回的令牌&pid=项目ID&mobile=获取的手机号
方法调用返回值示例:
1.成功返回:succ
2.失败返回值说明:
返回值说明
parameter_error传入参数错误
not_login没有登录,在没有登录下去访问需要登录的资源,忘记传入u
message|pleatryagainlater访问速度过快,建议休眠50毫秒后再试
account_is_locked账号被锁定
nding发送中
fail发送失败
not_found_project没找到发送任务
unknow_error未知错误,再次请求就会正确返回
本文发布于:2023-03-01 19:29:57,感谢您对本站的认可!
本文链接:https://www.wtabcd.cn/fanwen/zuowen/167767019899726.html
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,我们将在24小时内删除。
本文word下载地址:手机验证码.doc
本文 PDF 下载地址:手机验证码.pdf
留言与评论(共有 0 条评论) |