注册送短信

本机号码认证API


概览



vfmobile/Verify是submail的本机号码认证API,业务平台发起本机号码认证请求,支持三网。



URL


<主> http://tpa.mysubmail.com/vfmobile/verify  
<备> https://tpa.mysubmail.com/vfmobile/verify


http请求方式


请求方式content-type设置
http postmultipart/form-data、x-www-form-urlencoded、application/json


返回参数格式



jsonString



请求参数说明


参数是否必填类型类型
appidstring在 SUBMAIL 一键登录服务中创建并且认证通过的应用 ID
signaturestringappkey+时间戳+token拼接,并用sha256方式加密
osstring请求主体类型h5/小程序 h5=1 小程序=2
timestampstringUNIX 时间戳
tokenstringSDK 中获得的取号token
mobile_numberint待验证的手机号码
userInformationstring加密的浏览器指纹,由前端js采 集
typeint服务商类型,1=中国移动,2=中国联通,3=中国电信


响应消息


API请求失败
{
    'status' : 'error',                                           
    'code'   : 1301 ,                                             // API返回的状态码 
    'msg'    : 'Null appid' ,                                     // API返回的描述
    'msg_id' : 'ee05d1635db847a2bf3c8317434539d6',                // API流水号
}
API请求成功
{
    'status' : 'success',                                         // API返回的状态码
    'msg_id' : ee05d1635db847a2bf3c8317434539d6,                  // API流水号
    'result' : {
        'identical' : true ,                                      // 是否认证通过  true是 false否
        'msg' : 认证通过,                                           // 状态描述
    };
}
注意:
    status参数为success时,进行扣费。


API 返回参数状态码与描述


code参数msg描述
0successAPI请求成功
-1API Gateway Error:......接口请求失败,相关运营商错误码和错误描述
1301Null appidappid参数为空
1302Invalid appkey无效的appkey
1303Unknown mobile type未知的运营商类型参数
1304Unknown platform无效的操作类型 h5和小程序
1305Invalid timestamp无效的时间戳参数
1306Invalid appid无效的appid参数
1307Appid unauthorizedappid未授权
1308Invalid signature无效的signature参数
1309Appid is disabledAppid被禁用
1310Account is disabled账户被禁用
1311Appid does not existAppid不存在
1312Null tokentoken参数为空
1313Null phoneNum无效的手机号
1314Insufficient balance账户余额不足
1315Null userInformation无效的浏览器指纹
1316APPID has been set IP whitelist,your IP is not in the scope of this white list请求的 APPID 已设置 IP 白名单,您的 IP 不在此白名单范围
1317Account has no access账号没有该接口的权限
1318TIME OUT请求时间超时
1319Deduction Failed扣款失败
1319Credit Deduction Log Failed扣款日志记录失败
1320Appid Missing required parametersappid缺少必要参数