API开发文档

API接口说明文档

1、API系统说明

1.1、注意事项

  • 1. 所有接口访问地址和参数,都需区分大小写;
  • 2. 不能用的号码请及时加黑,不然下次还会被重复获取到;
  • 3. 开发者QQ:1069922211

2、用户登录

2.1、GET方式调用实例

  • http://150.242.99.60:8888/api/login?username=用户账号&password=用户密码

2.2、提交参数

参数名必传缺省值描述
usernameYes 用户账号
passwordYes 用户密码

2.3、返回值

  • 1|失败提示信息
  • 0| 登录成功|token=token[重要参数,后面的请求都需要]

2.4、备注

  • 只要密码不变,token是可以长期使用的,所以登录方法只需要调用一次 获取到token即可,程序运行中请不要重复调用

3、用户信息

3.1、GET方式调用实例

  • http://150.242.99.60:8888/api/getSummary?token=登录返回token

3.2、提交参数

参数名必传缺省值描述
tokenYes 登录返回token令牌

3.3、返回值

  • 1|失败提示信息
  • 0| 用户余额

4、接码取号

4.1、GET方式调用实例

  • http://150.242.99.60:8888/api/getjmphone?yysxz=0&token=登录返回令牌&qylx=0&xmid=项目id&qygjz=&yys=0&qyxz=0&author=开发者用户名

4.2、提交参数

参数名必传缺省值描述
tokenYes登录返回token
xmidYes项目id 或 对接码
yysxzYes运营商选择 (0=不限运营商,1=包含运营商,2,不含运营商)
yysNo1运营商(1电信2移动3联通4虚拟运营商)
qyxzYes地区选择(0不限地区1包含地区2不含地区)
qylxYes地区类型(1省份2城市)
qygjzNo地区关键字(默认为空 需要GBK编码)
authorNo开发者用户名

4.3、返回值

  • 1|失败提示信息
  • 0|手机号丨地区

4.4、备注

  • GET方式:运营商、区域都需要URL GBK编码
  • POST方式:运营商、区域都需要URL GBK编码

5、接码指定号码

5.1、GET方式调用实例

  • http://150.242.99.60:8888/api/jmDesignated?token=登录返回令牌&xmid=项目id&phone=手机号&author=开发者账号

5.2、提交参数

参数名必传缺省值描述
tokenYes登录返回token
xmidYes项目id 或 对接码
phoneYes指定手机号码
authorNo开发者账号

5.3、返回值

  • 1|失败提示信息
  • 0|手机号码|归属地

6、接码获取短信

6.1、GET方式调用实例

  • http://150.242.99.60:8888/api/jmgetMessage?token=登录返回token&xmid=项目id&phone=获取的号码

6.2、提交参数

参数名必传缺省值描述
tokenYes登录返回token
xmidYes项目id 或 对接码
PhoneYes获取的手机号码

6.3、返回值

  • 1|失败提示信息
  • 0|短信内容

6.4、备注

  • 当没有获取到短信时,需要再次调用此接口,建议每5秒调用一次

7、接码手机号加入黑名单

7.1、GET方式调用实例

  • http://150.242.99.60:8888/api/jmaddBlacklist?token=登录返回token&xmid=项目id&phone=需要拉黑的手机号

7.3、提交参数

参数名必传缺省值描述
tokenYes登录返回token
PhoneYes手机号码
xmidYes项目ID(不能填写对接码)

7.3、返回值

  • 1|失败提示信息
  • 0|成功

8、接码释放指定手机号

8.1、GET方式调用实例

  • http://150.242.99.60:8888/api/jmSpecified?token=登录返回token&xmid=项目ID&phone=需要释放的手机号

8.2、提交参数

参数名必传缺省值描述
tokenYes登录返回token
PhoneYes手机号码
xmidYes项目ID(不能填写对接码)

8.3、返回值

  • 1|失败提示信息
  • 0|成功

9、发码取号

9.1、GET方式调用实例

  • http://150.242.99.60:8888/api/getfmphone?yysxz=0&token=登录返回令牌&qylx=0&xmid=项目id&qygjz=&yys=0&qyxz=0&author=开发者用户名

9.2、提交参数

参数名必传缺省值描述
tokenYes登录返回token
xmidYes项目id 或 对接码
yysxzYes运营商选择 (0=不限运营商,1=包含运营商,2,不含运营商)
yysNo1运营商(1电信2移动3联通4虚拟运营商)
qyxzYes地区选择(0不限地区1包含地区2不含地区)
qylxYes地区类型(1省份2城市)
qygjzNo地区关键字(默认为空 需要GBK编码)
authorNo开发者用户名

9.3、返回值

  • 1|失败提示信息
  • 0|手机号丨地区

9.4、备注

  • GET方式:运营商、区域都需要URL GBK编码
  • POST方式:运营商、区域都需要URL GBK编码

10、发码指定号码

10.1、GET方式调用实例

  • http://150.242.99.60:8888/api/fmSpecified?token=登录返回token&xmid=项目id&phone=指定手机号&author=开发者账号

10.2、提交参数

参数名必传缺省值描述
tokenYes登录返回token
xmidYes项目id 或 对接码
phoneYes指定手机号码
authorNo开发者账号

10.3、返回值

  • 1|失败提示信息
  • 0|手机号码|归属地

11、提交发送短信内容

11.1、GET方式调用实例

  • http://150.242.99.60:8888/api/faduanxin?token=登录返回token&jshm=接收号码&phone=获取到的号码&xmid=项目ID&fsnr=发送内容

11.2、提交参数

参数名必传缺省值描述
tokenYes登录返回token
phoneYes获取到的号码
fsnrYes要发送的短信内容
jshmYes发送到号码
xmidYes项目id 或 对接码

11.3、返回值

  • 1|失败提示信息
  • 0|提交成功

12、发码取发送状态

12.1、GET方式调用实例

  • http://150.242.99.60:8888/api/fmgetMessage?token=登录返回token&xmid=项目id&phone=获取的号码

12.2、提交参数

参数名必传缺省值描述
tokenYes登录返回token
xmidYes项目id 或 对接码
PhoneYes获取的手机号码

12.3、返回值

  • 1|失败提示信息
  • 0|短信内容

12.4、备注

  • 当没有获取到短信时,需要再次调用此接口,建议每5秒调用一次

13、发码手机号加入黑名单

13.1、GET方式调用实例

  • http://150.242.99.60:8888/api/fmaddBlacklist?token=登录返回token&xmid=项目id&phone=需要拉黑的手机号

13.3、提交参数

参数名必传缺省值描述
tokenYes登录返回token
PhoneYes手机号码
xmidYes项目ID(不能填写对接码)

13.3、返回值

  • 1|失败提示信息
  • 0|成功

14、接码释放指定手机号

14.1、GET方式调用实例

  • http://150.242.99.60:8888/api/fmSpecified?token=登录返回token&xmid=项目ID&phone=需要释放的手机号

14.2、提交参数

参数名必传缺省值描述
tokenYes登录返回token
PhoneYes手机号码
xmidYes项目ID(不能填写对接码)

14.3、返回值

  • 1|失败提示信息
  • 0|成功