本机号码认证API
概览
vfmobile/Verify
是submail的本机号码认证API,业务平台发起本机号码认证请求,支持三网。
URL
<主> http://tpa.mysubmail.com/vfmobile/verify
<备> https://tpa.mysubmail.com/vfmobile/verify
http请求方式
请求方式 | content-type设置 |
---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
返回参数格式
jsonString
请求参数说明
参数 | 是否必填 | 类型 | 类型 |
---|
appid | 是 | string | 在 SUBMAIL 一键登录服务中创建并且认证通过的应用 ID |
signature | 是 | string | appkey+时间戳+token拼接,并用sha256方式加密 |
os | 是 | string | 请求主体类型h5/小程序 h5=1 小程序=2 |
timestamp | 是 | string | UNIX 时间戳 |
token | 是 | string | SDK 中获得的取号token |
mobile_number | 是 | int | 待验证的手机号码 |
userInformation | 是 | string | 加密的浏览器指纹,由前端js采 集 |
type | 否 | int | 服务商类型,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 | 描述 |
---|
0 | success | API请求成功 |
-1 | API Gateway Error:...... | 接口请求失败,相关运营商错误码和错误描述 |
1301 | Null appid | appid参数为空 |
1302 | Invalid appkey | 无效的appkey |
1303 | Unknown mobile type | 未知的运营商类型参数 |
1304 | Unknown platform | 无效的操作类型 h5和小程序 |
1305 | Invalid timestamp | 无效的时间戳参数 |
1306 | Invalid appid | 无效的appid参数 |
1307 | Appid unauthorized | appid未授权 |
1308 | Invalid signature | 无效的signature参数 |
1309 | Appid is disabled | Appid被禁用 |
1310 | Account is disabled | 账户被禁用 |
1311 | Appid does not exist | Appid不存在 |
1312 | Null token | token参数为空 |
1313 | Null phoneNum | 无效的手机号 |
1314 | Insufficient balance | 账户余额不足 |
1315 | Null userInformation | 无效的浏览器指纹 |
1316 | APPID has been set IP whitelist,your IP is not in the scope of this white list | 请求的 APPID 已设置 IP 白名单,您的 IP 不在此白名单范围 |
1317 | Account has no access | 账号没有该接口的权限 |
1318 | TIME OUT | 请求时间超时 |
1319 | Deduction Failed | 扣款失败 |
1319 | Credit Deduction Log Failed | 扣款日志记录失败 |
1320 | Appid Missing required parameters | appid缺少必要参数 |