会员中心

API接口说明文档

1、API接口系统说明

注: 软件作者在注册帐号时申请为普通用户就能享受软件提成哦!(普通用户都是开发者) 开发者提成项目金额的 10%

API 接口地址:http://api.xunma.net

接口统一编码:GB2312 [ 如需要使用UTF-8编码,请每个接口加入参数 Code=UTF8 ]

接口调用方式:HTTP GET方式

GET调用方法:http://api.xunma.net/Method?参数1=值&参数2=值(具体方法名及参数请参考接口方法)

1.1、注意事项

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

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

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

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

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

2、用户登录

GET - GET方式调用实例:http://api.xunma.net/Login?uName=用户名&pWord=密码&Developer=开发者参数

开发者参数请登录平台查看(普通用户)

2.1、请求参数

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

2.2、返回值

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

2.3、备注

注意:只要密码不变,登录方法只需要调用一次获取到token即可,程序运行中请不要重复调用

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

3、获取项目

GET - GET方式调用实例:http://api.xunma.net/GetItems?token=token&tp=ut

3.1、请求参数

参数名必传缺省值描述
tokenY登录token
tpY类型 [固定值 ut]

3.2、返回值

正确返回:

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

4、获取区域

GET - http://api.xunma.net/GetArea?

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

4.1、返回值

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

5、获取号码(注意:获取消息的项目ID为ItemId,此处的i为大写,注意大小写)

GET - http://api.xunma.net/getPhone?ItemId=项目ID&token=登陆token

5.1、请求参数

参数名必传缺省值描述
tokenY登录token
ItemIdY项目代码(获取消息的项目代码为itemId,注意大小写)
CountN1获取数量 [不填默认1个]
AreaN区域 [不填则 随机]td>
PhoneTypeN运营商 [不填为 0] 0 [随机] 1 [移动] 2 [联通] 3 [电信]
PhoneN指定号码

5.2、返回值

正确返回:13112345678;13698763743;13928370932;

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

6、获取消息(注意:获取消息的项目ID为itemId,此处的i为小写)

GET - http://api.xunma.net/getMessage?token=登陆token&itemId=项目ID&phone=手机号码

6.1、请求参数

参数名必传缺省值描述
tokenY登录token
phoneY手机号码
itemId(注意:此处的i为小写)Y项目ID

6.2、返回值

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

2.此接口需要一直调用,建议该方法每5秒调用一次,然后将获取的内容进行拆分匹配

3.此接口首次调用获取的是系统公告,忽略即可。

正确返回:【消息队列】消息队列介绍:
  • 1. 消息队列信息最后末尾为[End]结束
  • 2. 消息队列信息划分都已 & 符号分割
  • 3. 消息队列第一分割字符为命令类型
  • 消息队列命令种类
  • 1. 用户状态信息:USER&余额&最大登录数&最大获取号码数&客户端最大获取号码数&折扣
  • 2. 短信内容:MSG&项目ID&号码&短信内容
  • 3. 发送状态:STATE&项目ID&号码&状态信息
  • 4. 号码释放通知:RES&项目ID&号码

7、释放手机号码

GET - http://api.xunma.net/releasePhone?token=登陆token&phoneList=phone-itemId;phone-itemId;

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

7.1、请求参数

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

7.2、返回值

正确返回:【消息队列】,请到消息队列查看消息队列格式, 此处可能会有验证码短信内容

8、发送短信

GET - http://api.xunma.net/sendMessage?token=登陆token&Phone=手机号&ItemId=项目ID&Msg=短信内容

8.1、请求参数

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

8.2、返回值

正确返回:Ok

8.3、备注

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

9、添加号码到黑名单

GET-http://api.xunma.net/addBlack?token=登陆token&phoneList=itemId-phone;【单个项目单个号码】

GET-http://api.xunma.net/addBlack?token=登陆token&phoneList=itemId-phone,phone,phone;【单个项目多个不同号码】

GET-http://api.xunma.net/addBlack?token=登陆token&phoneList=itemId-phone;itemId-phone;【多个项目单个号码】

GET-http://api.xunma.net/addBlack?token=登陆token&phoneList=itemId-phone,phone,phone;itemId-phone,phone,phone;...;【多个项目多个号码】

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

9.1、请求参数

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

9.2、返回值

正确返回:【消息队列】,请到消息队列查看消息队列格式, 此处可能会有验证码短信内容

注意:当加入黑名单的号码为已经获取了的号码,则系统会自动释放此号码

10、退出

GET - http://api.xunma.net/Exit?token=登陆token[注:关闭软件前务必调用]

10.1、请求参数

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

10.2、返回值

正确返回:Ok