API简介 (操作说明 & 接口文档信息)   接口文档版本号: v1.1

🌟操作说明
1、收短信调用说明
1、调用接口【2.1/2.2】获取手机号码。
2、如果号码不能使用或已经被使用,请调用接口【5】加黑号码,这样不能使用或已经被使用的号码就不会被再次获取到。
3、如果号码可以使用,请调用接口【3】获取验证码,请间隔15秒调用10次(有些项目短信来得比较慢),超时时间为5分钟,如果多次还没返回,调用接口【5】加黑号码,成功获取验证码的项目可以不用加黑。
4、成功获取验证码的手机号码可以不用调用接口【4】释放手机号和接口【5】将手机号码加入黑名单。
5、为更高效率使用本平台手机号码可以调用接口【8】查看当时在线的手机号码国家的分布数量。
6、如有疑问或其他需求,请联系右下角客服。
2、操作建议
1、获取手机号码后,请及时注册,以确保验证码可以顺利接收(建议:获取手机号之后的5-60秒内注册,接收短信的时效为5分钟,超时之后手机号码将会自动释放)
2、使用号码时需要注意国家区号,网站获取到的手机号码全部是带有国家区号的手机号码,用户可根据自身需求来去掉或保留手机号码的国家区号(可在【2.1/2.2】获取手机号接口位置找到国家代码表)
🌟接口信息
参数:name:用户名,pwd:用户密码;所有接口验证'请求有效性'的必传参数
接口编码UTF-8,接口返回值为json格式
{
    "code": "", //返回码
    "msg": "",  //返回信息
    "data": ""  //返回数据
}
注意: 获取手机号接口为 2.1 / 2.2,使用方式和用途相同,只有在返回格式上不同。2.1接口直接返回手机号,2.2接口返回手机号和手机号的国际区号
1、获取用户信息
http://opapi.smspva.net/out/ext_api/getUserInfo?name=admin&pwd=123
name:用户名*
pwd:用户密码*
{
    "code": 200,
    "msg": "Success",
    "data": {
        "username": "admin",
        "score": 100,
        "create_date": "2018-05-09 11:18:35"
    }
}

//返回值参考
200:成功
800:账号被封禁
801:用户不存在
802:用户名或密码错误
803:用户名和密码不能为空
2.1、获取手机号/占用
http://opapi.smspva.net/out/ext_api/getMobile?name=admin&pwd=123&cuy=cn&pid=123&num=5&noblack=0&serial=2&secret_key=null&vip=null

友情提示:强烈建议获取手机号码后等待5秒钟再发送短信
name:用户名*
pwd:用户密码*
cuy:国家代码(二位缩写,不必须,默认所有国家)查看
pex:过滤号码前缀。格式:86135,国家代码(86,参照cuy国家代码)+前缀(135),总长度:2-6位
pid:项目ID*
num:获取手机号条数(1-10)*
noblack:过滤黑名单规则(0,1):0:只过滤自己添加的黑名单,1:过滤所有用户添加的黑名单*
serial:是否多条(1:为多条,2为单条)*
secret_key:特殊项目参数,如需添加联系管理员.否则为空*
vip:vip专属通道*
//单条数据格式
{
    "code": 200,
    "msg": "Success",
    "data": "+8613951100653"
}
//多条数据格式
{
    "code": 200,
    "msg": "Success",
    "data": [
        "+8613951100653",
        "+8613951100653"
    ]
}

//返回值参考
200:成功
800:账号被封禁
801:用户不存在
802:户名或密码错误
803:用户名和密码不能为空
902:传递的参数不正确
903:无效的国家代码
904:无效的项目ID
906:手机号列表为空
403:积分不足
400:失败,系统异常
907:vip_key错误
2.2、获取手机号/占用(版本2))
http://opapi.smspva.net/out/ext_api/getMobileCode?name=admin&pwd=123&cuy=cn&pid=123&num=5&noblack=0&serial=2&secret_key=null&vip=null

友情提示:强烈建议获取手机号码后等待5秒钟再发送短信
name:用户名*
pwd:用户密码*
cuy:国家代码(二位缩写,不必须,默认所有国家)查看
pex:过滤号码前缀。格式:86135,国家代码(86,参照cuy国家代码)+前缀(135),总长度:2-6位
pid:项目ID*
num:获取手机号条数(1-10)*
noblack:过滤黑名单规则(0,1):0:只过滤自己添加的黑名单,1:过滤所有用户添加的黑名单*
serial:是否多条(1:为多条,2为单条)*
secret_key:特殊项目参数,如需添加联系管理员.否则为空*
vip:vip专属通道*
//单条数据格式,格式为:国际通用手机号,手机号国际区号(国际区号分离有误差,仅供参考,最好校验后再使用)
{
    "code": 200,
    "msg": "Success",
    "data":"+8613951100653,+86"
}
//多条数据格式
{
    "code": 200,
    "msg": "Success",
    "data": [
        "+8613384364128,+86",
        "+8613951100653,+86"
    ]
}

//返回值参考
200:成功
800:账号被封禁
801:用户不存在
802:用户名或密码错误
803:用户名和密码不能为空
902:传递的参数不正确
903:无效的国家代码
904:无效的项目ID
906:手机号列表为空
403:积分不足
400:失败,系统异常
907:vip_key错误
3、获取验证码
http://opapi.smspva.net/out/ext_api/getMsg?name=admin&pwd=123&pn=+8613500000000&pid=123&serial=2
name:用户名*
pwd:用户密码*
pid:项目ID*
pn:手机号*
serial:是否多条(1:为多条,2为单条)*
{
    "code": 200,
    "msg": "Success",
    "data": "123456"
}

//返回值参考
200:成功
800:账号被封禁
801:用户不存在
802:用户名或密码错误
803:用户名和密码不能为空
904:无效的项目ID
905:无效的手机号码
908:暂未查询到验证码,请稍后再试
405:验证码获取失败,请查询数据列表,或联系管理员
        

注意:serial参数必须与获取手机号时serial的参数一致,否则获取不到信息返回405

4、释放手机号
http://opapi.smspva.net/out/ext_api/passMobile?name=admin&pwd=123&pn=+8613500000000&pid=123&serial=2
name:用户名*
pwd:用户密码*
pid:项目ID*
pn:手机号*
serial:是否多条(1:为多条,2为单条)*
{
    "code": 200,
    "msg": "Success",
    "data": ""
}

//返回值参考
200:成功
800:账号被封禁
801:用户不存在
802:用户名或密码错误
803:用户名和密码不能为空
401:失败,无效操作
904:无效的项目ID
905:无效的手机号码
5、手机号码加黑名单
http://opapi.smspva.net/out/ext_api/addBlack?name=admin&pwd=123&pn=+8613500000000&pid=123
友情提示:强烈建议收到短信后或者连续多次没有收到短信再加入黑名单,频繁加入黑名单,会影响拿号成功率
name:用户名*
pwd:用户密码*
pid:项目ID*
pn:手机号*
{
    "code": 200,
    "msg": "Success",
    "data": 1
}

//返回值参考
200:成功
800:账号被封禁
801:用户不存在
802:用户名或密码错误
803:用户名和密码不能为空
400:失败,系统异常
904:无效的项目ID
905:无效的手机号码
912:请勿重复操作
6、查询号码状态
http://opapi.smspva.net/out/ext_api/getStatus?name=admin&pwd=123&pn=+8613500000000&pid=123
name:用户名*
pwd:用户密码*
pid:项目ID*
pn:手机号*
{
    "code": 203,
    "msg": "The number is not occupied and no SMS is received",
    "data": ""
}

//返回值参考
200:成功
800:账号被封禁
801:用户不存在
802:用户名或密码错误
803:用户名和密码不能为空
904:无效的项目ID
905:无效的手机号码
201:验证码已下发
202:号码已占用,未接到到短信
203:号码未占用,未接到到短信
7、查询手机号是否加入黑名单
http://opapi.smspva.net/out/ext_api/getBlack?name=xxxx&pwd=xxxn&pn=+8613500000000&pid=xx
name:用户名*
pwd:用户密码*
pid:项目ID*
pn:手机号*
{
    "code": 200100,
    "msg": "Blacklist added successfully",
    "data": ""
}

//返回值参考
200100:黑名单已经添加成功
800:账号被封禁
801:用户不存在
802:用户名或密码错误
803:用户名和密码不能为空
904:无效的项目ID
905:无效的手机号码
400100:该手机号没有添加黑名单

8、查询国家手机号数量
http://opapi.smspva.net/out/ext_api/getCountryPhoneNum?name=admin&pwd=123&pid=null&vip=null
name:用户名*
pwd:用户密码*
pid:对应项目的id*
vip:vip专属通道*
{
    "code":200,
    "msg":"Success",
    "data":{
        "th":2,
        "id":1,
        "in":1
    }
}
//返回值参考
200:成功
403: 没有数据
800:账号被封禁
801:用户不存在
802:用户名或密码错误
803:用户名和密码不能为空
907:vip_key错误