快速了解每位云平台
快速了解每位云平台
通过快速入门教程,实践案例等各项操作指南,帮助新用户更快的了解梦网云产品的使用
号码认证
一键认证服务,整合三大运营商网关认证能力,在用户无感知过程实现手机号码身份认证,一键完成本机号登录或认证; 通信授权服务,提供用户授权数据实时存证、查询和管理能力。
号码认证资料压缩包
号码认证文档


 

梦网平台H5本机号码校验集成使用说明文档


(V1.0)


深圳市梦网科技发展有限公司

二○二一年三月
修改记录

版本号

发布日期

修改部分简要




 


目录

目录

1. 产品介绍

2. 时序图

3. 本机号码校验jssdk使用说明

3.1获取Token方法

4. 接口说明

4.1 本机号码校验接口verify_phone

4.1.1 请求URL

4.1.2 请求方式

4.1.3 请求参数说明

4.1.4 返回参数说明

4.1.5 Post请求示例

4.1.7 发送成功返回示例

4.1.8 发送失败返回示例

5. 规则说明

5.1鉴权规则

6. 错误代码表

7. 注意事项

 


 

 

1. 产品介绍

梦网H5本机号码校验是梦网科技研发团队聚焦互联网时代背景,整合了三大运营商特有的数据网关认证能力,提供快速、安全、便捷的用户身份信息校验能力的全新一代验证解决方案,支持在H5页面上一步校验输入号码与当前SIM卡号一致性,应用于用户注册、登录、安全校验等场景,可实现用户无感知校验,操作更安全、便捷、低时延,有效提升拉新转化率和用户留存率。具有覆盖全网、sdk便捷接入、降低校验成本等优势。

2. 时序图

H5本机号码校验流程说明:

1. 用户请求验证页面;

2. 页面加载认证jssdk

3. 调用jssdk获取Token接口(mwGetToken)

4. 调用获取Token接口成功后,页面提供用户输入手机号;

5. 用户输入手机号,确认发起校验后,携带手机号、Token信息传输给H5应用服务器;

6. 应用服务器收到页面校验请求后,调用应用服务端本机号码校验接口(verify_phone)进行号码校验;

7. 应用服务器判断校验结果,是否允许用户继续进行相关业务处理。

 

重要参数说明:

1.H5应用所需报备信息:

H5应用名称

H5应用描述

H5应用服务器IP

集成页面地址

Origin地址

 

2.报备信息说明:

2.1.集成页面地址

集成了本机号码校验能力的页面访问地址,若多个页面集成用英文逗号分隔上报。必须报备至可访问的完整页面地址,不允许使用通配符

(注:假如业务方集成认证的页面访问地址为 http://www.abc.com/a/mobile.html/#/abc,则报备地址为 http://www.abc.com/a/mobile.html/)。

 

2.2.Origin地址

注意Origin地址结尾处没有“/”,若多个页面集成用英文逗号分隔上报

 

①假如业务方集成认证的页面访问地址为 http://www.abc.com/a/mobile.html,则originhttp://www.abc.com

②假如业务方集成认证的页面访问地址为 https://www.abc.com/a/mobile.html,则originhttps://www.abc.com

 

③假如业务方集成认证的页面访问地址为 http://127.0.0.1:8080/a/mobile.html,则originhttp://127.0.0.1:8080

④假如业务方集成认证的页面访问地址为 https://127.0.0.1:8080/a/mobile.html,则originhttps://127.0.0.1:8080

 

3.H5应用服务器IP

①多个IP用逗号隔开,例如127.0.0.1,127.0.0.2

(注:应用服务器IPH5应用后台向认证服务发起验号请求的服务器出口IP

 

3. 本机号码校验jssdk使用说明

本机号码校验jssdk引用方法。


 

3.1获取Token方法

mwGetToken({

data:{

mwAppId: appid, //应用id

isToken : false //是否使用模拟环境,该参数默认填false

}

success: function(res) {

// 回调成功

res:{

mwAppId:appid, //应用Id

token : token,  // 认证服务返回的token

userInformation : userInformation, //用户相关信息

svcid : svcid,  // 认证服务的渠道id

svc_appid : svc_appid,  //认证服务渠道应用id

msgId : msgId,  //认证请求流水号

timestamp : timestamp //时间戳

 }

 },

error: function(res) {

  // 回调失败

}

})

4.接口说明

4.1 本机号码校验接口verify_phone

4.1.1 请求URL

https://ip:port/unilogin/h5/v1/verify_phone

4.1.2 请求方式

POST

4.1.3 请求参数说明

参数

类型

是否必须

描述

示例

appid

int

应用ID

示例:100001

custid

string

用户自定义流水号:本次请求在您业务系统内的ID,比如流水号。

最大可支持64位的ASCII字符串:字母、数字、下划线、减号,如不需要则不用提交此字段或填空

示例:783d31b21b857

timestamp

string

时间戳精确到毫秒格式:yyyyMMddhhmmssSSS

示例:20210312174831641

checksum

string

报文主体明文的CRC32校验和(大写)

示例:A1B2C3D4

payload

string

报文主体密文,报文格式说明中的payload字段 = BASE64( AES(json_data) )

使用AES/CBC/PKCS7进行加密,并对密文使用BASE64进行编码,填入到payload字段中

■ 计算APP_KEY的SHA256散列值作为AES加密的秘钥

■ 加密分组模式CBC的初始化向量为全0(128位-16字节)

 

示例:VGhpcyBpcyBhIGRlbW8gc3RyaW5nLg==

1-1

payload参数,使用json格式:

参数

    类型

描述

示例

svcid

string

渠道ID(由JSSDK获取token方法返回)

示例10001

svc_appid

string

渠道APPID(由JSSDK获取token方法返回)

示例20001

version

string

版本号默认1.0

示例1.0

mobile

string

用户输入的手机号

示例13852124521

token

string

JSSDK获取token方法返回

示例:G8gc3RyaW5nLg==

userInformation

string

加密的浏览器指纹,(JSSDK获取token方法返回)

示例:SserrD445fdtg==

 

1-2

 

4.1.4 返回参数说明

参数

    类型

描述

示例

result

int

短信发送请求处理结果:

0:成功

0:失败,详见6.错误代码表

示例0

desc

string

应答结果描述,当result非0时,为错误描述

 

示例“鉴权失败”

msgid

string

运营商流水号

示例9223372036854775808

custid

string

用户自定义流水号:默认与请求报文中的custid保持一致,若请求报文中没有custid参数或值为空,则custid为空

示例b3d0a2783d31b21b8573

timestamp

string

时间戳精确到毫秒格式:yyyyMMddhhmmssSSS

示例:20210312174831641

1-2

4.1.5 Post请求示例

JSON

{

"appid": 100100,

  "custid": "1234567890",

  "timestamp": "20210312174831641",

  "checksum": "A1B2C3D4",

  "payload": "VGhpcyBpcyBhIGRlbW8gc3RyaW5nLg=="

}

payload

{

  "svcid": "100100",

"svc_appid": "300001",

"version": "1.0",

"phoneNum”: “13852154874",

  "token":" VG8gc3RyaW5nLg==",

"userInformation”: “dfdfserrf445fdt5"

}

4.1.7 发送成功返回示例

JSON (请求都以JSON返回数据)

{

"result": 0,

"desc": "是本机号码"

"msgid ": "10000001",

"custid": "1234567890",

" timestamp": "20210312174831641"

}

4.1.8 发送失败返回示例

JSON (请求都以JSON返回数据)

{

"result": 10001,

"desc": "请求参数错误"

"msgid ": "10000001",

"custid": "1234567890",

" timestamp": "20210312174831641"

}

 

5. 规则说明


5.1鉴权规则 

报文格式说明中的payload字段 = BASE64( AES_CBC_PKCS7(json_data) )

使用AES/CBC/PKCS7进行加密,并对密文使用BASE64进行编码,填入到payload字段中

■ 计算APP_KEYSHA256散列值作为AES加密的秘钥

■ 加密分组模式CBC的初始化向量为全0128-16字节)

报文格式说明中的checksum字段 = CRC32 (json_data) )

 

6. 错误代码表

 

HTTP响应码定义

响应码

响应码描述

响应码解释说明

403

No permissions

参数错误,视为无请求权限

404

URL Not Allowed

请求URL非法

405

Method Not Allowed

不支持的请求方法

408

Request Timeout

客户端没有在服务器预备等待的时间内完成一个请求的发送

 

结果返回码定义

返回码

返回码描述

返回码解释说明

是否退费(/:未计费)

0

success

校验成功,是本机号码

/

10001

params invalid

请求参数错误(json格式异常、缺少字段、字段值为空或为零)

/

10002

url invalid

URL异常,请求被拒绝

/

10003

system inner error

系统内部错误,例如:
    ①根据appid从缓存查询应用信息、绑定关系失败;
    ②根据service_id从缓存查询渠道信息失败;
    ③计费失败(余额不足or调接口失败)

/

10004

appkey expire

秘钥已过期

/

10005

app unbind this svc

应用未绑定对应渠道

/

10006

svc offline

渠道已下线

/

10007

no carrier ability

渠道没有对应运营商能力

/

10008

query failed

取号失败,例如:
    ①取号服务端未响应(提交失败);
    ②取号服务端明确返回失败;

10009

verify failed

校验失败,例如:
    ①验证服务端未响应(提交失败);
    ②验证服务器明确返回失败;

10010

request timeout

请求超时(失败)

10011

respond params invalid

响应数据包格式异常

10012

charge failed

计费失败

/

10013

ip not in white list

请求IP地址不在白名单

/

10014

service id invalid

不支持的渠道业务类型

/

10099

unknown error

未知错误

/

 

7.注意事项


1.本机号码校验需通过移动数据流量进行验证,建议页面提示用户关闭wifi后发起验证。


5秒钟闪电体验  10分钟快速接入  2小时实现商用
立即注册
联系热线:4009-002123
在线客服
我的梦网云
返回顶部