重要申明:平台后台收到短信即计费,所以如果在未收到短信的情况下,请主动调用释放接口,如果任他不管,在后台强制释放前收到了短信照样计费。
接口调用需加入延时机制,否则会封帐号、IP。
接口地址:http://localhost:9000/yhapi.ashx
接口说明:汉字使用url编码
请求方式:仅支持get请求
尽可能把每次调用接口返回值保存日志,需要技术协助时,必须提供接口返回日志
接口返回“1|*”表示接口请求成功,返回“0|*”表示接口请求失败。*表示信息内容
| 参数名 | 参数值 | 必传 | 参数说明 |
|---|---|---|---|
| act | login | 是 | 固定值,不允许修改 |
| ApiName | Api用户名 | 是 | 非注册用户名,正确格式:*#(*表示注册时用户名,#表示2个随机数字)[点击查看ApiName]登录后在:API对接--我的APIName模块 |
| PassWord | 登陆密码 | 是 | 注册时的登陆密码 |
| 失败代号 | 代号说明 |
|---|---|
| -1 | 用户账号不允许为空 |
| -2 | 用户账号长度必须在3-30之间 |
| -3 | 用户账号不能包含特殊符号“|” |
| -4 | 用户账号不能包含汉字 |
| -5 | 用户密码不允许为空 |
| -6 | 用户密码长度必须在3-30之间 |
| -7 | 同IP情况下,上次请求失败,1分钟后重试【请确保Api用户名与登录密码正确再重试】 |
| -8 | 账号已被禁用 |
| -9 | 账号或密码错误 |
| 参数名 | 参数值 | 必传 | 参数说明 |
|---|---|---|---|
| act | myInfo | 是 | 固定值,不允许修改 |
| token | 接口一返回的token值 | 是 | 接口一(用户登陆接口)返回的token值 |
| 失败代号 | 代号说明 |
|---|---|
| -1 | Token不存在 |
| -2 | token失效,请重新调用登陆接口 |
| -3 | 请延时60秒后再请求,该接口调用频率60秒/次 |
| 参数名 | 参数值 | 必传 | 参数说明 |
|---|---|---|---|
| act | getPhone | 是 | 固定值,不允许修改 |
| token | 接口一返回的token值 | 是 | 接口一(用户登陆接口)返回的token值 |
| iid | 项目ID | 是 | 在用户端查看 |
| did | 开发者ID | 在开发者端查看 | |
| operator | 运营商 | 汉字请url编码 | |
| provi | 归属地-省 | 汉字请url编码 | |
| city | 归属地-市 | 汉字请url编码 | |
| seq | 号段选择 | 0 或 1 或 2;0代表不限号段,1代表只获取虚拟号段,2代表只获取正常号段 | |
| mobile | 指定手机号 | 获取指定的手机号 |
| 失败代号 | 代号说明 |
|---|---|
| -1 | 暂时无号 |
| -2 | Token不存在 |
| -3 | 项目ID不存在 |
| -4 | 未知错误码 |
| -5 | 项目未审核 |
| -6 | 项目已禁用 |
| -7 | 用户已禁用 |
| -8 | 余额不足,请充值 |
| -9 | 占号过多,请补充余额【未收到验证码强烈建议主动调用释放接口,否则在余额不多的情况下会提示占号过多】 |
| -10 | 项目不允许指定取号 |
实现多次收码
| 参数名 | 参数值 | 必传 | 参数说明 |
|---|---|---|---|
| act | getPhoneCode | 是 | 固定值,不允许修改 |
| token | 接口一返回的token值 | 是 | 接口一(用户登陆接口)返回的token值 |
| pid | 取号接口返回pid | 是 | 获取手机号接口返回值中的pid值 |
| 失败代号 | 代号说明 |
|---|---|
| -1 | Token不存在 |
| -2 | pid不存在 |
| -3 | 等待验证码 |
| -4 | 已离线或强制释放【请做好此判断,可以避免多个手机同时获取到相同号码的错觉】 |
| -5 | 未知错误码 |
没有收到短信都是以失败返回
| 参数名 | 参数值 | 必传 | 参数说明 |
|---|---|---|---|
| act | sendCode | 是 | 固定值,不允许修改 |
| token | 接口一返回的token值 | 是 | 接口一(用户登陆接口)返回的token值 |
| pid | 取号接口返回pid | 是 | 获取手机号接口返回值中的pid值 |
| receiver | 接收方号码 | 是 | 接收短信的号码,如:10086 |
| smscontent | 短信内容 | 是 | 请勿发送违法短信 |
| 失败代号 | 代号说明 |
|---|---|
| -1 | Token不存在 |
| -2 | pid不存在 |
| -3 | 接收号码不能为空 |
| -4 | 提交短信不能为空 |
| -5 | 未知错误码 |
| -6 | 手机号不存在或已释放【请做好此判断,可以避免多个手机同时获取到相同号码的错觉】 |
| -7 | 手机号状态不可用,一般是手机号已经回码了 |
| -8 | 收码项目不允许发送短信 |
| -9 | 项目未设置关键字,请联系平台 |
| -10 | 发送内容不符合规则 |
| -11 | 发送内容重复提交 |
使用接口三(获取验证码接口)来获取短信发送回执
仅在没有收到短信时调用,如果收到了短信无需调用此接口,释放存在失败的情况
| 参数名 | 参数值 | 必传 | 参数说明 |
|---|---|---|---|
| act | setRel | 是 | 固定值,不允许修改 |
| token | 接口一返回的token值 | 是 | 接口一(用户登陆接口)返回的token值 |
| pid | 取号接口返回pid | 是 | 获取手机号接口返回值中的pid值 |
| 失败代号 | 代号说明 |
|---|---|
| x | x为正整数,表示x秒后才允许被释放。例如:返回0|30,表示30秒后才允许被释放 |
| -1 | Token不存在 |
| -2 | pid不存在 |
| -3 | 手机号不存在或已释放【请做好此判断,可以避免多个手机同时获取到相同号码的错觉】 |
| -4 | 已回码,不允许释放 |
| -5 | 短信已提交发送,不允许释放 |
| -6 | 释放超过次数,自动加黑 |
仅在以后不想再用到这个号码时调用,其他非特殊情况无需调用此接口,加黑存在失败的情况
| 参数名 | 参数值 | 必传 | 参数说明 |
|---|---|---|---|
| act | addBlack | 是 | 固定值,不允许修改 |
| token | 接口一返回的token值 | 是 | 接口一(用户登陆接口)返回的token值 |
| pid | 取号接口返回pid | 是 | 获取手机号接口返回值中的pid值 |
| reason | 加黑原因 | 是 | 汉字经过url编码 |
| 失败代号 | 代号说明 |
|---|---|
| -1 | Token不存在 |
| -2 | pid不存在 |
| -3 | 加黑原因不能为空 |
| -4 | 手机号不存在或已释放【请做好此判断,可以避免多个手机同时获取到相同号码的错觉】 |
| -5 | 未回码,请释放 |
调用该接口需要配置权限,注册默认没有此接口权限,如需开通请联系平台,【专属对接可联系卡商开通】
未分配权限者,请勿调用,避免账户余额减少
| 参数名 | 参数值 | 必传 | 参数说明 |
|---|---|---|---|
| act | apiReturn | 是 | 固定值,不允许修改 |
| token | 接口一返回的token值 | 是 | 接口一(用户登陆接口)返回的token值 |
| pid | 取号接口返回pid | 是 | 获取手机号接口返回值中的pid值 |
| remark | 反馈信息 | 是 | (固定值 0:成功,-1:失败,-2:验证码超时,-3:号码已注册),其他信息请直接输入 |
| 失败代号 | 代号说明 |
|---|---|
| -1 | Token不存在 |
| -2 | pid不存在 |
| -3 | 反馈说明不能为空 |
| -4 | 当前账号无法操作此号码 |
| -5 | 未开通Api反馈权限 |
当需要再次使用手机号时调用(非指定取号多次收码)
收到验证码后调用
再次使用会重新结算费用,非特殊项目,请勿调用,避免账户余额减少
| 参数名 | 参数值 | 必传 | 参数说明 |
|---|---|---|---|
| act | setAgain | 是 | 固定值,不允许修改 |
| token | 接口一返回的token值 | 是 | 接口一(用户登陆接口)返回的token值 |
| pid | 取号接口返回pid | 是 | 获取手机号接口返回值中的pid值 |
| min | 多少分钟后再次使用 | 否 | (值范围2-10),默认值是5,代表5分钟后再次使用 |
| 失败代号 | 代号说明 |
|---|---|
| -1 | Token不存在 |
| -2 | pid不存在 |
| -3 | min参数值错误,(值范围2-10),默认值是5,代表5分钟后再次使用 |
| -4 | 手机号不存在或已释放【请做好此判断,可以避免多个手机同时获取到相同号码的错觉】 |
| -5 | 未回码,请释放 |