智能号码认证产品API文档#


版权所有 翻版必究


目录

一键登录接口#

一键登录请求#

请求URL:#

集群URL支持产品列表
北京http://api-oneclick-bj.fengkongcloud.com/oneclick/v1一键登录

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

2s

请求参数:#

放在HTTP Body中,采用Json格式,具体参数如下: | 请求参数名 | 类型 | 参数说明 | 传入说明 | 规范 | | --- | --- | --- | --- | --- | | accessKey | string | 接口认证密钥
用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看 | 必传参数 | accessKey | | appId | string | 应用标识,用于区分相同公司的不同应用数据 | 必传参数 | 默认应用值:default
传递其他值时需联系数美服务协助开通 | | data | json_object | 请求的数据内容 | 必传参数 | 请求的数据内容,最长10MB,详见data参数 |

其中,data的内容如下:

请求参数名类型参数说明是否必传规范
tokenIdstring用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值非必传参数由数字、字母、下划线、短杠组成的长度小于等于64位的字符串
accessTokenstring运营商授权码,用于向运营商获取手机号必传参数调用数美sdk获取
osstring平台类型标识必传参数平台类型
可选值:
andrid
ios
weapp
h5
deviceInfostring加密的浏览器指纹,由weapp/h5端SDK采集。android/ios可传空值必传参数调用数美sdk获取

返回结果#

放在HTTP Body中,采用Json格式,具体参数如下:

参数名称参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
3000:运营商错误
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功QPS超限参数不合法服务失败余额不足无权限操作
requestIdstring请求标识请求唯一标识,用于排查问题和后续效果优化,强烈建议保存
phoneRsastring请求结果加密后的手机号,加密方式为:RSA加密,客户使用私钥解密

示例:#

请求示例:#

{
"accessKey":"",
"appId":"",
"data":{
"tokenId":"username123",
"accessToken":"",
"os":"android",
"deviceInfo":""
}
}

同步返回示例:#

{
"code":1100,
"message":"成功",
"requestId":"69dbc1f81dc5c914b1f1b8a267fb9ec1",
"phoneRsa":""
}

本机号码校验接口#

本机号码校验请求#

请求URL:#

集群URL支持产品列表
北京http://api-phoneverify-bj.fengkongcloud.com/phoneverify/v1本机号码校验

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

2s

请求参数:#

放在HTTP Body中,采用Json格式,具体参数如下: | 请求参数名 | 类型 | 参数说明 | 传入说明 | 规范 | | --- | --- | --- | --- | --- | | accessKey | string | 接口认证密钥
用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看 | 必传参数 | accessKey | | appId | string | 应用标识,用于区分相同公司的不同应用数据 | 必传参数 | 默认应用值:default
传递其他值时需联系数美服务协助开通 | | eventId | string | 时间标识 | 必传参数 | 在本机号码验证场景中建议传入进行区分,否则为default | | data | json_object | 请求的数据内容 | 必传参数 | 请求的数据内容,最长10MB,详见data参数 |

其中,data的内容如下:

请求参数名类型参数说明是否必传规范
lastReqstring前置天网事件请求标识非必传参数前置天网事件返回的请求requestId
tokenIdstring用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值非必传参数由数字、字母、下划线、短杠组成的长度小于等于64位的字符串
accessTokenstring运营商授权码,用于向运营商获取手机号必传参数调用数美sdk获取
phoneRsastring手机号必传参数加密后的手机号,用于后续向运营商进行认证是否为本机号码
加密方式:RSA加密。请求时使用公钥加密
osstring平台类型标识必传参数平台类型
可选值:
andrid
ios
weapp
h5
deviceInfostring加密的浏览器指纹,由weapp/h5端SDK采集。android/ios可传空值必传参数调用数美sdk获取

返回结果#

放在HTTP Body中,采用Json格式,具体参数如下:

参数名称参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
3000:运营商错误
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功QPS超限参数不合法服务失败余额不足无权限操作
requestIdstring请求标识请求唯一标识,用于排查问题和后续效果优化,强烈建议保存
riskLevelstring验证结果可能返回值:
PASS:正常(运营商返回认证通过)
REVIEW:重试(运营商返回无法确认)
REJECT:拒绝(运营商返回认证不通过)

示例:#

请求示例:#

{
"accessKey":"",
"appId":"",
"eventId":"",
"data":{
"lastReq":"",
"tokenId":"username123",
"accessToken":"",
"phoneRsa":"",
"os":"android",
"deviceInfo":""
}

同步返回示例:#

{
"code":1100,
"message":"成功",
"requestId":"69dbc1f81dc5c914b1f1b8a267fb9ec1",
"verifyResult":3
}

在线咨询