本機(jī)號(hào)碼認(rèn)證API
概覽
vfmobile/Verify
是submail的本機(jī)號(hào)碼認(rèn)證API,業(yè)務(wù)平臺(tái)發(fā)起本機(jī)號(hào)碼認(rèn)證請(qǐng)求,支持三網(wǎng)。
URL
<主> http://tpa.mysubmail.com/vfmobile/verify
<備> https://tpa.mysubmail.com/vfmobile/verify
http請(qǐng)求方式
請(qǐng)求方式 | content-type設(shè)置 |
---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
返回參數(shù)格式
jsonString
請(qǐng)求參數(shù)說(shuō)明
參數(shù) | 是否必填 | 類(lèi)型 | 類(lèi)型 |
---|
appid | 是 | string | 在 SUBMAIL 一鍵登錄服務(wù)中創(chuàng)建并且認(rèn)證通過(guò)的應(yīng)用 ID |
signature | 是 | string | appkey+時(shí)間戳+token拼接,并用sha256方式加密 |
os | 是 | string | 請(qǐng)求主體類(lèi)型h5/小程序 h5=1 小程序=2 |
timestamp | 是 | string | UNIX 時(shí)間戳 |
token | 是 | string | SDK 中獲得的取號(hào)token |
mobile_number | 是 | int | 待驗(yàn)證的手機(jī)號(hào)碼 |
userInformation | 是 | string | 加密的瀏覽器指紋,由前端js采 集 |
type | 否 | int | 服務(wù)商類(lèi)型,1=中國(guó)移動(dòng),2=中國(guó)聯(lián)通,3=中國(guó)電信 |
響應(yīng)消息
API請(qǐng)求失敗
{
'status' : 'error',
'code' : 1301 , // API返回的狀態(tài)碼
'msg' : 'Null appid' , // API返回的描述
'msg_id' : 'ee05d1635db847a2bf3c8317434539d6', // API流水號(hào)
}
API請(qǐng)求成功
{
'status' : 'success', // API返回的狀態(tài)碼
'msg_id' : ee05d1635db847a2bf3c8317434539d6, // API流水號(hào)
'result' : {
'identical' : true , // 是否認(rèn)證通過(guò) true是 false否
'msg' : 認(rèn)證通過(guò), // 狀態(tài)描述
};
}
注意:
status參數(shù)為success時(shí),進(jìn)行扣費(fèi)。
API 返回參數(shù)狀態(tài)碼與描述
code參數(shù) | msg | 描述 |
---|
0 | success | API請(qǐng)求成功 |
-1 | API Gateway Error:...... | 接口請(qǐng)求失敗,相關(guān)運(yùn)營(yíng)商錯(cuò)誤碼和錯(cuò)誤描述 |
1301 | Null appid | appid參數(shù)為空 |
1302 | Invalid appkey | 無(wú)效的appkey |
1303 | Unknown mobile type | 未知的運(yùn)營(yíng)商類(lèi)型參數(shù) |
1304 | Unknown platform | 無(wú)效的操作類(lèi)型 h5和小程序 |
1305 | Invalid timestamp | 無(wú)效的時(shí)間戳參數(shù) |
1306 | Invalid appid | 無(wú)效的appid參數(shù) |
1307 | Appid unauthorized | appid未授權(quán) |
1308 | Invalid signature | 無(wú)效的signature參數(shù) |
1309 | Appid is disabled | Appid被禁用 |
1310 | Account is disabled | 賬戶(hù)被禁用 |
1311 | Appid does not exist | Appid不存在 |
1312 | Null token | token參數(shù)為空 |
1313 | Null phoneNum | 無(wú)效的手機(jī)號(hào) |
1314 | Insufficient balance | 賬戶(hù)余額不足 |
1315 | Null userInformation | 無(wú)效的瀏覽器指紋 |
1316 | APPID has been set IP whitelist,your IP is not in the scope of this white list | 請(qǐng)求的 APPID 已設(shè)置 IP 白名單,您的 IP 不在此白名單范圍 |
1317 | Account has no access | 賬號(hào)沒(méi)有該接口的權(quán)限 |
1318 | TIME OUT | 請(qǐng)求時(shí)間超時(shí) |
1319 | Deduction Failed | 扣款失敗 |
1319 | Credit Deduction Log Failed | 扣款日志記錄失敗 |
1320 | Appid Missing required parameters | appid缺少必要參數(shù) |