本文将为你介绍H5本机号码校验SDK相关内容。

一、引入JSSDK

开发者需要在H5页面中集成号码认证服务的JSSDK,并在服务端完成API对接。

  1. 静态资源引入。
    下载打包好的js文件引入项目目录。
    <script type="text/javascript" charset="utf-8" src="xxx/numberAuth-web-sdk-1.0.2.js"></script>
  2. npm引入。
    npm资源地址:https://www.npmjs.com/package/aliyun_numberauthsdk_web
    npm i aliyun_numberauthsdk_web
    为保证服务正常使用,需在页面的html文件中的head标签里面添加代码。
    <meta name="referrer" content="origin">

二、SDK接口说明

1、初始化实例

// 初始化实例
const { PhoneNumberServer } = window; //引用静态资源包
import { PhoneNumberServer } from 'aliyun_numberauthsdk_web'; //引用cdn资源包

this.phoneNumberServer = new PhoneNumberServer();

设置SDK是否开启日志(开启后会在控制台打印更多内容便于排查问题)。

this.phoneNumberServer.setLoggerEnable();

参数说明

isEnable 是否开启 true/false

2、获取号码认证sdk版本号

const sdkVersion = this.phoneNumberServer.getVersion();  // 返回sdk版本号 eg: '1.0.0'

3、身份鉴权

this.phoneNumberServer.checkAuthAvailable({
    phoneNumber: '151********',
    accessToken: 'XXXXXXXXxx',
    jwtToken:'******',
    success:function(res){
      console.log(res.jwtToken);
      console.log(res.accessToken); 
    },
    
    error: function(res){
      
    }
    
});
参数说明
参数名称 参数说明
phoneNumber 本机号码
AccessToken 号码认证业务鉴权token由阿里云对外暴露的getAuthToken 接口生成
JwtToken API鉴权token由阿里云对外暴露的getAuthToken 接口生成
success 成功回调
error 失败回调

4、获取本机号码校验token

this.phoneNumberServer.getVerifyToken({
    success:function(res){
    console.log(res.
      
    },
    
    error: function(res){
      
    }
    
});
参数说明
success 成功回调
error 失败回调
返回值说明
code 成功6000(其他详见错误码)
spToken 运营商token
content 失败时运营商返回的内容

错误码说明

返回码 web
600000 成功的返回code
600004 方案号不存在
600009 无法判断运营商
600010 未知异常
600011 获取token失败
600013 运营商维护升级,该功能不可用
600014 运营商维护升级,该功能已达最大调用次数
600015 接口超时
600025 接入方身份信息校验失败
600008 环境错误(未在蜂窝网络下使用或未使用手机浏览器)
600028 入参错误(未传入手机号码,accessToken,jwtToken)

除阿里云SDK返回码外,运营商返回码见阿里云官网运营商SDK错误码

三、其他说明

  • 需要提示用户在断开wifi的情况下使用,仅支持蜂窝网络下使用。
  • 身份鉴权成功后才可以调获取token的接口。