当前位置: 首页 > API接口
API接口说明文档

1、API接口系统说明

API 接口地址:http://xapi.yika66.com

接口统一编码:GB2312(UTF8请在接口后台添加参数&code=utf8)

接口调用方式:HTTP GET方式

GET方式GB2312调用方法:http://xapi.yika66.com/login?参数1=值&参数2=值(具体方法名及参数请参考接口方法)

GET方式UTF8调用方法:http://xapi.yika66.com/login?参数1=值&参数2=值&code=utf8(具体方法名及参数请参考接口方法)

1.1、注意事项

1. 所有接口访问地址和参数,都需区分大小写,一定需注意。

2. 所有接口如有错误,前端都会有一个False:后面则是错误信息,下面接口说明不在说明错误信息,其他为正确。

3. 当没有按照接口说明的参数去调用,参数没有携带完整,则系统会返回 False:信息不完整。

4. 登录后,如果在10分钟没有再次用token访问其他接口信息,则登录token会被系统自动回收,如果再用以前的token去访问,则会返回:Session过期,这样需重新再次登陆,使用新的token。

5. 获取号码在20分钟内没有被用户释放,系统会强制进行释放信息。

6. 开发者交流群:321936580

2、用户登录

GET - GET方式GB2312调用实例:http://xapi.yika66.com/User/login?uName=用户名&pWord=密码&Developer=开发者参数[注:请登录平台查看]

2.1、请求参数

参数名必传缺省值描述
uNameY用户名
pWordY密码
DeveloperN开发者参数
codeNutf8转UTF8编码

2.2、返回值

登录token&账户余额&最大登录客户端个数&最多获取号码数&单个客户端最多获取号码数&折扣

3、获取项目

GET - GET方式GB2312调用实例:http://xapi.yika66.com/User/getItems?token=token&tp=ut

3.1、请求参数

参数名必传缺省值描述
tokenY登录token
tpN类型 [固定值 ut]
codeNutf8转UTF8编码

3.2、返回值

正确返回:

项目ID&项目名称&项目价格&项目类型\n项目ID&项目名称&项目价格&项目类型\n...
  • 其中项目类型解释如下:
  • 1. 表示此项目用于接收验证码
  • 2. 表示此项目用户发送短信
  • 3. 表示此项目即可接收验证码,也可以发送短信
  • 4. 表示可以接受多个验证码

4、获取区域

GET - http://xapi.yika66.com/User/getArea?

无请求参数[注意: ? 号必须加上]

4.1、返回值

正确返回例子: 重庆\n上海\n北京\n

5、获取号码

GET方式GB2312调用实例- http://xapi.yika66.com/User/getPhone?ItemId=项目ID&token=登陆token

5.1、请求参数

参数名必传缺省值描述
tokenY登录token
ItemIdY项目代码
PhoneN指定手机号
CountN1获取数量 [不填默认1个]
AreaN区域 [不填则 随机]
PhoneTypeN0运营商 [不填为 0] 0 [随机] 1 [移动] 2 [联通] 3 [电信]
codeNutf8转UTF8编码

5.2、返回值

正确返回:成功返回:13112345678; 多个号码返回值:13112345678;13698763743;13928370932;

注意:如果Count数量为20,获取后,确只返回了10个号码,则证明系统已经没有那

6、获取消息

GET - http://xapi.yika66.com/User/getMessage?token=登陆token&ItemId=项目ID&Phone=获取的号码

6.1、请求参数

参数名必传缺省值描述
tokenY登录token
ItemIdY项目ID
PhoneY获取的号码
codeNutf8转UTF8编码

6.2、返回值

消息队列介绍:

1. 消息队列信息最后末尾为结束
2. 消息队列信息划分都已 符号分割
3. 消息队列第一分割字符为命令类型

消息队列命令种类介绍:

第一次调用接口会获取网站的公告,第二次以后才是验证码,每获取完一次验证码都会返回用户状态信息

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

2.此接口需要一直调用,建议该方法每5秒调用一次

正确返回:

1. 用户状态信息:
      &余额&最大登录数&最大获取号码数&客户端最大获取号码数&折扣
2. 短信内容:
      &项目ID&号码(注意判断对应的号码)&短信内容,例如:MSG&52&13425096612&【小米】小米帐号注册手机验证码 8457[End]RES&52&13425096612[End]
3. 发送状态:
      &项目ID&号码(注意判断对应的号码)&短信内容
4. 号码释放通知:
      &项目ID&号码
多号号码返回的内容必须根据手机号来分割获取验证码

7、释放手机号码

GET - http://xapi.yika66.com/User/releasePhone?token=登陆token&phoneList=phone-itemId;phone-itemId;

号码列表格式: phone-itemId;phone-itemId; 其中phone为号码,itemId为项目ID, 请注意后面的分号需要加上

7.1、请求参数

参数名必传缺省值描述
tokenY登录token
phoneListY号码列表

7.2、返回值

正确返回:Ok

8、释放全部号码

GET - http://xapi.yika66.com/User/ReleaseAllPhone?token=登陆token

8.1、请求参数

参数名必传缺省值描述
tokenY登录token

8.2、返回值

正确返回:Ok

9、发送短信

GET - http://xapi.yika66.com/User/sendMessage?token=登陆token&Phone=手机号&ItemId=项目ID&Msg=短信内容

9.1、请求参数

参数名必传缺省值描述
tokenY登录token
ItemIdY项目代码
phoneY号码
MsgY短信内容

9.2、返回值

正确返回:Ok

9.3、备注

注意:调用“发送短信”后,通过 “获取消息”检查短信发送状态

10、添加号码到黑名单

GET-http://xapi.yika66.com/User/addBlack?token=登陆

token&phoneList=itemId-phone,phone,phone;itemId-phone,phone;

号码列表格式: itemId-phone,phone,phone;itemId-phone,phone; 其中phone为号码,itemId为项目ID, 请注意后面的分号需要加上

10.1、请求参数

参数名必传缺省值描述
tokenY登录token
phoneListY号码列表

10.2、返回值

正确返回:Ok

11、退出

GET - http://xapi.yika66.com/User/exit?token=登陆token[注:关闭软件前务必调用]

11.1、请求参数

参数名必传缺省值描述
tokenY登录token

11.2、返回值

正确返回:Ok