手机验证码自动接收y码系统API说明.docx
《手机验证码自动接收y码系统API说明.docx》由会员分享，可在线阅读，更多相关《手机验证码自动接收y码系统API说明.docx（10页珍藏版）》请在冰点文库上搜索。
手机验证码自动接收y码系统API说明
手机验证码自动接收（y码）系统API说明
∙系统API的说明
接口地址：
接口统一编码：
UTF-8
接口调用方式：
HTTP，支持GET和POST两种方式。
接口调用时间间隔：
50毫秒。
如果低于50毫秒会提示"message|pleasetryagainlater"
GET调用方法：
注意：
服务器返回no_data时表示系统暂时没有可用号码了，请使用死循环每隔一分钟请求一次手机号，Y码平台是不定时加号的。
max_count_disable出现这个提示是因为您获取的号码以达到上限，每个获取到的号码都必须正确处理（要么调用ReleaseMobile释放号码退出任务，要么获取验证码，要么号码不能用加黑，要么号码收不到短信加黑。
getRecvingInfo方法可以查看您当前获取的手机号码
如果接口返回action_parameter_error表示传入方法名错误或方法不存在。
∙用户登录
[方法名] loginIn
传入参数：
1.uid:
用户名
2.pwd:
密码
GET方式调用实例：
方法调用返回值示例：
1.成功返回：
用户名|token（下面所有方法都要用的令牌）
2.失败返回值说明：
返回值
说明
login_error
用户名密码错误
message|pleasetryagainlater
访问速度过快，建议休眠50毫秒后再试
account_is_locked
账号被锁定
login_error
用户名密码错误
∙获取用户个人信息
[方法名] getUserInfos
传入参数：
1.uid=用户名
2.token=登录时返回的令牌
GET方式调用实例：
方法调用返回值示例：
1.成功返回：
用户名;积分;余额;可同时获取号码数
2.失败返回值说明
返回值
说明
parameter_error
传入参数错误
not_login
没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token
message|pleasetryagainlater
访问速度过快，建议休眠50毫秒后再试
account_is_locked
账号被锁定
unknow_error
未知错误,再次请求就会正确返回
∙获取手机号码
[方法名] 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方式调用实例：
方法调用返回值示例：
1.成功返回：
手机号码|token 注意：
多个号码返回值：
手机号;手机号;手机号|token
2.失败返回值说明：
返回值
说明
no_data
系统暂时没有可用号码了
max_count_disable
已达到用户可获取号码上限，可通过调用ReleaseMobile方法释放号码并终止任务
parameter_error
传入参数错误
not_login
没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token
message|pleasetryagainlater
访问速度过快，建议休眠50毫秒后再试
account_is_locked
账号被锁定
mobile_notexists
指定的号码不存在
mobile_busy
指定的号码繁忙
unknow_error
未知错误,再次请求就会正确返回
∙释放已获取的手机号码
[方法名] ReleaseMobile
说明：
此方法可以释放用户获取的所有号码，并终止进行中的任务
传入参数：
1.uid=用户名
2.token=登录时返回的令牌
3. mobile=已获取到的手机号（仅限单个号码），可不填，不填就释放所有号码
GET方式调用实例：
方法调用返回值示例：
1.成功返回：
OK
2.失败返回值说明
返回值
说明
parameter_error
传入参数错误
not_login
没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token
message|pleasetryagainlater
访问速度过快，建议休眠50毫秒后再试
account_is_locked
账号被锁定
unknow_error
未知错误,再次请求就会正确返回
∙获取验证码并不再使用本号
[方法名]getVcodeAndReleaseMobile
说明：
1.使用该方法获得验证码后，系统自动加黑该号码
2.因部分短信可能延迟，所以建议该方法每5秒调用一次，调用100秒（可增加获取成功率）
传入参数：
1.mobile=用getMobilenum方法获取到的手机号
2.token=登录时返回的令牌
3.uid=用户名
4.pid=项目ID
5.author_uid=开发者用户名（可选,传入此参数必须是注册类型为软件开发者的用户名，在获取验证码时传入软件开发者用户名,则按本次消费金额的10%奖励给软件开发者）
GET方式调用实例：
方法调用返回值示例：
1.成功返回：
手机号码|验证码短信
2.失败返回值说明：
返回值
说明
not_receive
还没有接收到验证码,请让程序等待几秒后再次尝试
parameter_error
传入参数错误
not_login
没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token
message|pleasetryagainlater
访问速度过快，建议休眠50毫秒后再试
account_is_locked
账号被锁定
unknow_error
未知错误,再次请求就会正确返回
∙获取验证码并继续使用本号
[方法名]getVcodeAndHoldMobilenum
说明：
1.使用该方法获得验证码后，如果这个号码可以多少次使用，下次还会获取
2.因部分短信可能延迟，所以建议该方法每5秒调用一次，调用100秒（可增加获取成功率）
传入参数：
1.mobile=用getMobilenum方法获取到的手机号
2.token=登录时返回的令牌
3.uid=用户名
4.pid=项目ID
5.author_uid=开发者用户名（可选,传入此参数必须是注册类型为软件开发者的用户名，在获取验证码时传入软件开发者用户名,则按本次消费金额的10%奖励给软件开发者）
GET方式调用实例：
方法调用返回值示例：
1.成功返回：
手机号码|验证码短信
2.失败返回值说明：
返回值
说明
not_receive
还没有接收到验证码,请让程序等待几秒后再次尝试
parameter_error
传入参数错误
not_login
没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token
message|pleasetryagainlater
访问速度过快，建议休眠50毫秒后再试
account_is_locked
账号被锁定
unknow_error
未知错误,再次请求就会正确返回
∙加黑无用号码
[方法名]addIgnoreList
说明：
该方法使用于
1.无法注册的手机号码（对方网站提示不可用）
2.超过100秒都无法获取短信的手机号码
3.调用getVcodeAndHoldMobilenum方法使用结束后的号码
传入参数：
1.pid=项目ID
2.mobiles=以,号分隔的手机号列表
3.uid=用户名
4.token=登录时返回的令牌
GET方式调用实例：
方法调用返回值示例：
1.成功返回：
加黑成功的号码数量
2.失败返回值说明：
返回值
说明
parameter_error
传入参数错误
not_login
没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token
message|pleasetryagainlater
访问速度过快，建议休眠50毫秒后再试
account_is_locked
账号被锁定
unknow_error
未知错误,再次请求就会正确返回
∙已获取号码列表
[方法名]getRecvingInfo
传入参数：
1.uid=用户名
2.token=登录时返回的令牌
3.pid=项目ID（pid等于0的时候获取所有号码，pid不等于0的时候获取指定项目号码）
GET方式调用实例：
方法调用返回值示例：
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
message|pleasetryagainlater
访问速度过快，建议休眠50毫秒后再试
account_is_locked
账号被锁定
unknow_error
未知错误,再次请求就会正确返回
∙发短信
[方法名]sendSms
说明：
调用sendSms方法后，通过getSmsStatus方法检查短信发送状态
传入参数：
1.pid=项目ID
2.mobile=用getMobilenum方法获取到的手机号
3.uid=用户名
4.token=登录时返回的令牌
5.recv=接收号码，必须是项目指定的接收号码
6.content=短信内容
7.author_uid=开发者用户名（可选,传入此参数必须是注册类型为软件开发者的用户名，在获取验证码时传入软件开发者用户名,则按本次消费金额的10%奖励给软件开发者）
GET方式调用实例：
方法调用返回值示例：
1.成功返回：
OK
2.失败返回值说明：
返回值
说明
parameter_error
传入参数错误
not_login
没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token
message|pleasetryagainlater
访问速度过快，建议休眠50毫秒后再试
account_is_locked
账号被锁定
Recv_Err
短信接收号码不在项目允许的范围内
Task_NotExists
任务不存在，可能超时被释放，请重新获取号码
message|此项目不支持发送短信
此项目不支持发送短信
unknow_error
未知错误,再次请求就会正确返回
∙获取短信发送状态
[方法名]getSmsStatus
说明：
该方法使用于发送短信后，检查短信是否发送成功
传入参数：
1.pid=项目ID
2.mobile=用getMobilenum方法获取到的手机号
3.uid=用户名
4.token=登录时返回的令牌
GET方式调用实例：
方法调用返回值示例：
1.成功返回：
succ
2.失败返回值说明：
返回值
说明
parameter_error
传入参数错误
not_login
没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token
message|pleasetryagainlater
访问速度过快，建议休眠50毫秒后再试
account_is_locked
账号被锁定
sending
发送中
fail
发送失败
not_found_project
没找到发送任务
unknow_error
未知错误,再次请求就会正确返回
升级会员 