API使用说明

接口地址: http://api.shop.com/api/
接口统一编码:UTF-8
接口调用方式: HTTP,使用GET方式
GET调用方法:http://api.shop.com/api/?参数1=值&参数2=值(具体方法名及参数请参考接口方法)
参数说明:method指接口类型;account指登录名;pwd指登录密码
客服QQ: 技术QQ:

获取用户信息接口

接口地址:http://api.shop.com/api/?method=UserInfo&account=account&pwd=pwd
传入参数:
method:UserInfo,方法为获取用户信息
account:登录名
pass:登录密码
返回值:{"c":1,"score":100}

c(返回码) 返回码含义
1 成功
-1 用户名密码错误
-2 账户异常
-3 账户被锁定
-6 参数错误
-100 其他错误

获取/占用手机号码接口

接口地址:http://api.shop.com/api/?method=GetPhone&account=account&pwd=pwd&pid=PID&pro=PRO&city=CITY&carr=CARR&pn=PHONE&q=Q
传入参数:
method:GetPhone,方法为获取手机号码
account:登录名
pwd:登录密码
pid:项目ID(项目ID编码见【项目管理】中的项目ID,只能指定一个项目ID,如果需要多个项目ID,请联系技术人员)
pn:指定手机号码占用,如要占用13888888888,则传13888888888,如获取新的手机号码,无需传该参数
pro:省(非必填,具体代码值请联系技术人员)
city:城市(非必填,具体代码值请联系技术人员)
carr:运营商 1电信 2移动 3联通 (非必填)
q:一次获取手机号个数,默认为1(非必填,取值范围1~30)
返回值:
{"c":1,"phones":["13788889999"]}
多个手机号返回值:
{"c":1,"phones":["13788889999","13788888888","13788887777"]}

c(返回码) 返回码含义
1 成功
-1 用户名密码错误
-2 账户异常
-3 账户被锁定
-4 积分不足
-5 项目不存在
-6 参数错误
-7 系统繁忙,请稍后再试
-8 您的绑定项目中不含此项目
-9 正在使用的手机号码过多
-10 此项目缺号
-11 指定的手机不存在
-100 其他错误

phones : 获取到的手机号码
调用例子:
(1)取项目ID为1的手机号:
http://api.shop.com/api/?method=GetPhone&account=account&pwd=pwd&pid=1
返回:{"c":1,"phones":["13888888888"]},则13888888888可以使用
(2)指定号码使用另一个项目,如占用项目ID为2的手机号13888888888:
http://api.shop.com/api/?method=GetPhone&account=account&pwd=pwd&pid=2&pn=13888888888
返回:{"c":1,"phones":["13888888888"]},则占用ID为2的13888888888手机号成功
(3)再次使用项目ID为2的手机号13888888888:
http://api.shop.com/api/?method=GetPhone&account=account&pwd=pwd&pid=2&pn=13888888888
返回:{"c":1,"phones":["13888888888"]},则13888888888手机号可以再次用来注册项目2

通过手机号码获取验证码接口

接口地址:http://api.shop.com/api/?method=GetCode&account=account&pwd=pwd&pid=PID&pn=phone&dev=DEV
传入参数:
method:GetCode,方法为获取验证码
account:登录名
pwd:登录密码
pid:项目ID
pn:手机号码
dev:开发者登录名(对于开发者用户具有10%的提成,需注册开发者类型账户,非必填项)
返回值:
未接收到验证码,返回:{"c":0}

c(返回码) 返回码含义
0 平台未接收到验证码短信
1 成功
-1 用户名密码错误
-2 账户异常
-3 账户被锁定
-4 积分不足
-5 项目不存在
-6 参数错误
-7 系统繁忙,请稍后再试
-8 您的绑定项目中不含此项目
-11 指定的手机不存在
-100 其他错误

接收到验证码,返回:{"c":1,"m":"您的验证码为888999","mc":"888999"}
m:接收到的短信内容
mc:短信验证码,自动提取的验证码

释放号码

接口地址:http://api.shop.com/api/?method=Release&account=account&pwd=pwd&pid=PID&pn=phone
传入参数:
method:Release,方法为释放号码
account:登录名
pwd:登录密码
pid:项目ID(项目ID编码见【项目管理】中的项目ID),如不传此参数,则表示所有项目
pn:要释放的手机号码,如要释放13888888888,则传13888888888,如不传此参数,则表示所有手机号码
返回值:{"c":1}

c(返回码) 返回码含义
1 释放成功
-1 用户名密码错误
-5 项目不存在

手机号码加入黑名单接口

接口地址:http://api.shop.com/api/?method=AddBlack&account=account&pwd=pwd&pid=PID&pn=phone
传入参数:
method:AddBlack,方法为加入黑名单
account:登录名
pwd:登录密码
pid:项目ID
pn:手机号码
返回值:{"c":1}

c(返回码) 返回码含义
1 成功
-1 用户名密码错误
-2 账户异常
-3 账户被锁定
-5 项目不存在
-6 参数错误
-7 系统繁忙,请稍后再试
-8 您的绑定项目中不含此项目
-12 已经加黑或者无此号码
-100 其他错误

查询状态接口

接口地址:http://api.shop.com/api/?method=GetStatus&account=account&pwd=pwd&pid=PID&pn=phone
传入参数:
method:GetStatus,方法为查询短信状态
account:登录名
pwd:登录密码
pid:项目ID
pn:手机号码
返回值:{"c":1,"m":"0"}

c(返回码) 返回码含义
1 查询成功
-1 用户名密码错误
-5 项目不存在
-6 参数错误
-11 指定的手机不存在
-100 其他错误
当返回码为“1”时m的含义:
m(状态信息) 收短信 发短码
0 已提交接收短信请求 已经占用号码
1 已成功收到短信
2 已提交发送短信请求,正在排队发送
3 发送短信中
9 您已获取短信验证码 短信已发送成功