手机验证码自动接收(y码)系统API说明

admin管理员组

文章数量:1532771

2024年1月9日发(作者：)

手机验证码自动接收（y码）系统API说明

•

系统API的说明

接口地址： /?action=

接口统一编码：UTF-8

接口调用方式： HTTP，支持GET和POST两种方式。

接口调用时间间隔： 50毫秒。如果低于50毫秒会提示 "message|please try again

later"

GET调用方法：/?action=方法名&参数1=值&参数2=值（具体方法名及参数请参考接口方法）

注意：

服务器返回no_data时表示系统暂时没有可用号码了，请使用死循环每隔一分钟请求一次手机号，Y码平台是不定时加号的。

max_count_disable出现这个提示是因为您获取的号码以达到上限，每个获取到的号码都必须正确处理(要么调用ReleaseMobile释放号码退出任务，要么获取验证码，要么号码不能用加黑，要么号码收不到短信加黑。getRecvingInfo方法可以查看您当前获取的手机号码

如果接口返回action_parameter_error 表示传入方法名错误或方法不存在。

•

用户登录

[方法名] loginIn

传入参数：

1. uid:用户名

2. pwd:密码

GET方式调用实例：/?action=loginIn&uid=用户名&pwd=密码

方法调用返回值示例：

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

2. 失败返回值说明：

返回值

login_error

message|please try again later

account_is_locked

login_error

•

说明

用户名密码错误

访问速度过快，建议休眠50毫秒后再试

账号被锁定

用户名密码错误

获取用户个人信息

[方法名] getUserInfos

传入参数：

1. uid=用户名

2. token=登录时返回的令牌

GET方式调用实例：/?action=getUserInfos&uid=用户名&token=登录时返回的令牌

方法调用返回值示例：

1.成功返回：用户名;积分;余额;可同时获取号码数

2. 失败返回值说明

返回值

parameter_error

not_login

message|please try again later

account_is_locked

unknow_error

说明

传入参数错误

访问速度过快，建议休眠50毫秒后再试

账号被锁定

未知错误,再次请求就会正确返回

没有登录,在没有登录下去访问需要登录的资源，忘记传入u•

获取手机号码

[方法名] getMobilenum

说明：项目ID请登录Y码官网，查看项目管理获得

传入参数：

1. pid=项目ID

2. uid=登录用户名

3. token=登录时返回的令牌

4. lock=是否锁定号码(可以不填写该参数，"1"为锁定。同一个号码接多条短信以上可锁定，以便用已获取的号码来重复接收短信)

5. size=获取号码数(可以不填，默认为1，1<=size<=10)

6. mobile=指定号码获取(可以不填写该参数)

7. cr=指定运营商（1:电信 2:移动 3:联通） (可以不填写该参数)

GET方式调用实例：/?action=getMobilenum&pid=项目ID&uid=用户名&token=&size=1

方法调用返回值示例：

1.成功返回：手机号码|token 注意：多个号码返回值：手机号;手机号;手机号|

token

2. 失败返回值说明：

返回值

no_data

max_count_disable

parameter_error

not_login

message|please try again later

account_is_locked

mobile_notexists

mobile_busy

说明

系统暂时没有可用号码了

传入参数错误

访问速度过快，建议休眠50毫秒后再试

账号被锁定

指定的号码不存在

指定的号码繁忙

已达到用户可获取号码上限，可通过调用ReleaseMobile方没有登录,在没有登录下去访问需要登录的资源，忘记传入u

unknow_error

•

未知错误,再次请求就会正确返回

释放已获取的手机号码

[方法名] ReleaseMobile

说明：此方法可以释放用户获取的所有号码，并终止进行中的任务

传入参数：

1. uid=用户名

2. token=登录时返回的令牌

3. mobile=已获取到的手机号（仅限单个号码），可不填，不填就释放所有号码

GET方式调用实例：/?action=ReleaseMobile&uid=用户名&token=登录时返回的令牌

方法调用返回值示例：

1.成功返回：OK

2. 失败返回值说明

返回值

parameter_error

not_login

message|please try again later

account_is_locked

unknow_error

说明

传入参数错误

访问速度过快，建议休眠50毫秒后再试

账号被锁定

未知错误,再次请求就会正确返回

没有登录,在没有登录下去访问需要登录的资源，忘记传入u•

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

[方法名]getVcodeAndReleaseMobile

说明：

1.使用该方法获得验证码后，系统自动加黑该号码

2. 因部分短信可能延迟，所以建议该方法每5秒调用一次，调用100秒（可增加获取成功率）

传入参数：

1. mobile=用getMobilenum方法获取到的手机号

2. token=登录时返回的令牌

3. uid=用户名

4. pid=项目ID

5. author_uid=开发者用户名(可选,传入此参数必须是注册类型为软件开发者的用户名，在获取验证码时传入软件开发者用户名,则按本次消费金额的10%奖励给软件开发者)

GET方式调用实例：/?action=getVcodeAndReleaseMobile&uid=用户&token=登录时返回的令牌&pid=项目ID&mobile=获取到的手机号码

方法调用返回值示例：

1.成功返回：手机号码|验证码短信

2. 失败返回值说明：

返回值

not_receive

parameter_error

not_login

message|please try again later

account_is_locked

unknow_error

•

说明

还没有接收到验证码,请让程序等待几秒后再次尝试

传入参数错误

访问速度过快，建议休眠50毫秒后再试

账号被锁定

未知错误,再次请求就会正确返回

没有登录,在没有登录下去访问需要登录的资源，忘记传入u获取验证码并继续使用本号

[方法名]getVcodeAndHoldMobilenum

说明：

1.使用该方法获得验证码后，如果这个号码可以多少次使用，下次还会获取

2. 因部分短信可能延迟，所以建议该方法每5秒调用一次，调用100秒（可增加获取成功率）

传入参数：

1. mobile=用getMobilenum方法获取到的手机号

2. token=登录时返回的令牌

3. uid=用户名

4. pid=项目ID

5. author_uid=开发者用户名(可选,传入此参数必须是注册类型为软件开发者的用户名，在获取验证码时传入软件开发者用户名,则按本次消费金额的10%奖励给软件开发者)

GET方式调用实例：/?action=getVcodeAndHoldMobilenum&uid=用户&token=登录时返回的令牌&pid=项目ID&mobile=获取到的手机号码

方法调用返回值示例：

1.成功返回：手机号码|验证码短信

2. 失败返回值说明：

返回值

not_receive

parameter_error

not_login

message|please try again later

account_is_locked

unknow_error

•

说明

还没有接收到验证码,请让程序等待几秒后再次尝试

传入参数错误

访问速度过快，建议休眠50毫秒后再试

账号被锁定

未知错误,再次请求就会正确返回

没有登录,在没有登录下去访问需要登录的资源，忘记传入u加黑无用号码

[方法名]addIgnoreList

说明：该方法使用于

1.无法注册的手机号码（对方网站提示不可用）

2. 超过100秒都无法获取短信的手机号码

3. 调用getVcodeAndHoldMobilenum方法使用结束后的号码

传入参数：

1. pid=项目ID

2. mobiles=以,号分隔的手机号列表

3. uid=用户名

=登录时返回的令牌

GET方式调用实例：/?action=addIgnoreList&uid=用户名&token=登录时返回的令牌&mobiles=号码1,号码2,号码3&pid=项目ID

方法调用返回值示例：

1.成功返回：加黑成功的号码数量

2. 失败返回值说明：

返回值

parameter_error

not_login

message|please try again later

account_is_locked

unknow_error

•

说明

传入参数错误

访问速度过快，建议休眠50毫秒后再试

账号被锁定

未知错误,再次请求就会正确返回

没有登录,在没有登录下去访问需要登录的资源，忘记传入u已获取号码列表

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,"Recmeout":号码超时释放所剩时间,"Start_time":获取号码时间},{...}]（*"Timeout"以秒为单位）

返回值说明：

说明

传入参数错误

没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token

访问速度过快，建议休眠50毫秒后再试

账号被锁定

未知错误,再次请求就会正确返回

ter_error

in

e|please try again later

_is_locked

_error

•

发短信

[方法名]sendSms

说明：调用sendSms方法后，通过 getSmsStatus方法检查短信发送状态

传入参数：

1. pid=项目ID

2. mobile=用getMobilenum方法获取到的手机号

3. uid=用户名

4. token=登录时返回的令牌

5. recv=接收号码，必须是项目指定的接收号码

6. content=短信内容

7. author_uid=开发者用户名(可选,传入此参数必须是注册类型为软件开发者的用户名，在获取验证码时传入软件开发者用户名,则按本次消费金额的10%奖励给软件开发者)

GET方式调用实例：/?action=sendSms&uid=用户名&token=登录时返回的令牌&pid=项目ID&mobile=获取的手机号&recv=短信接收号码&content=短信内容&author_uid=开发者用户名(可选)

方法调用返回值示例：

1.成功返回：OK

2. 失败返回值说明：

返回值

parameter_error

not_login

message|please try again later

account_is_locked

Recv_Err

Task_NotExists

message|此项目不支持发送短信

unknow_error

•

说明

传入参数错误

访问速度过快，建议休眠50毫秒后再试

账号被锁定

短信接收号码不在项目允许的范围内

任务不存在，可能超时被释放，请重新获取号码

此项目不支持发送短信

未知错误,再次请求就会正确返回

没有登录,在没有登录下去访问需要登录的资源，忘记传入u获取短信发送状态

[方法名]getSmsStatus

说明：该方法使用于发送短信后，检查短信是否发送成功

传入参数：

1. pid=项目ID

2. mobile=用getMobilenum方法获取到的手机号

3. uid=用户名

4. token=登录时返回的令牌

GET方式调用实例：/?action=getSmsStatus&uid=用户名&token=登录时返回的令牌&pid=项目ID&mobile=获取的手机号

方法调用返回值示例：

1.成功返回：succ

2. 失败返回值说明：

返回值

parameter_error

not_login

说明

传入参数错误

没有登录,在没有登录下去访问需要登录的资源，忘记传入u

message|please try again later

account_is_locked

sending

fail

not_found_project

unknow_error

访问速度过快，建议休眠50毫秒后再试

账号被锁定

发送中

发送失败

没找到发送任务

未知错误,再次请求就会正确返回

本文标签： 号码获取登录方法