# riskControl.getUserRiskRank
本接口应在服务器端调用,详细说明参见服务端 API。
本接口支持云调用。需开发者工具版本 >=
1.02.1904090
(最新稳定版下载),wx-server-sdk
>=0.4.0
根据提交的用户信息数据获取用户的安全等级 risk_rank,无需用户授权。
调用方式:
# HTTPS 调用
# 请求地址
POST https://api.weixin.qq.com/wxa/getuserriskrank?access_token=ACCESS_TOKEN
# 请求参数 - Query
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token / cloudbase_access_token | string | 是 | 接口调用凭证 |
# 请求参数 - Body
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
appid | string | 是 | 小程序 appid | |
openid | string | 是 | 用户的 openid | |
scene | number | 是 | 场景值,0:注册,1:营销作弊 | |
mobile_no | string | 否 | 用户手机号 | |
client_ip | string | 是 | 用户访问源 ip | |
email_address | string | 否 | 用户邮箱地址 | |
extended_info | string | 否 | 额外补充信息 | |
is_test | boolean | 否 | false:正式调用,true:测试调用 |
# 返回值
# Object
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 返回码 |
errmsg | string | 错误信息 |
unoin_id | number | 唯一请求标识,标记单次请求 |
risk_rank | number | 用户风险等级 |
errcode 的合法值
值 | 说明 | 最低版本 |
---|---|---|
-1 | 系统繁忙,此时请开发者稍候再试 | |
0 | 成功 | |
40001 | token 无效 | |
40003 | openid 无效 | |
40129 | 场景值错误(目前支持场景 0:注册,1:营销作弊) | |
43104 | appid 与 openid 不匹配 | |
43302 | 方法调用错误,请用 post 方法调用 | |
44002 | 传递的参数为空 | |
47001 | 传递的参数格式不对 | |
48001 | 小程序无该 api 权限 | |
61010 | 用户访问记录超时(用户未在近两小时访问小程序) | |
9410009 | 测试额度已耗尽 | |
其他 | 系统错误 |
risk_rank 的合法值
值 | 说明 | 最低版本 |
---|---|---|
0 | 风险等级 0 | |
1 | 风险等级 1 | |
2 | 风险等级 2 | |
3 | 风险等级 3 | |
4 | 风险等级 4 |
# 请求数据示例
{
"appid": "wx*******",
"openid": "*****",
"scene": 1,
"mobile_no": "12345678",
"bank_card_no": "******",
"cert_no": "*******",
"client_ip": "******",
"email_address": "***@qq.com",
"extended_info": ""
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "getuserriskrank succ",
"risk_rank": 0,
"unoin_id": 123456
}
# 云调用
云调用是微信云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过
wx-server-sdk
使用。
# 接口方法
openapi.riskControl.getUserRiskRank;
需在
config.json
中配置riskControl.getUserRiskRank
API 的权限,详情
# 请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
appid | string | 是 | 小程序 appid | |
openid | string | 是 | 用户的 openid | |
scene | number | 是 | 场景值,0:注册,1:营销作弊 | |
mobileNo | string | 否 | 用户手机号 | |
clientIp | string | 是 | 用户访问源 ip | |
emailAddress | string | 否 | 用户邮箱地址 | |
extendedInfo | string | 否 | 额外补充信息 | |
isTest | boolean | 否 | false:正式调用,true:测试调用 |
# 返回值
# Object
属性 | 类型 | 说明 |
---|---|---|
errCode | number | 返回码 |
errMsg | string | 错误信息 |
unoinId | number | 唯一请求标识,标记单次请求 |
riskRank | number | 用户风险等级 |
errCode 的合法值
值 | 说明 | 最低版本 |
---|---|---|
0 | 成功 |
riskRank 的合法值
值 | 说明 | 最低版本 |
---|---|---|
0 | 风险等级 0 | |
1 | 风险等级 1 | |
2 | 风险等级 2 | |
3 | 风险等级 3 | |
4 | 风险等级 4 |
# 异常
# Object
抛出的异常
属性 | 类型 | 说明 |
---|---|---|
errCode | number | 返回码 |
errMsg | string | 错误信息 |
errCode 的合法值
值 | 说明 | 最低版本 |
---|---|---|
-1 | 系统繁忙,此时请开发者稍候再试 | |
40001 | token 无效 | |
40003 | openid 无效 | |
40129 | 场景值错误(目前支持场景 0:注册,1:营销作弊) | |
43104 | appid 与 openid 不匹配 | |
43302 | 方法调用错误,请用 post 方法调用 | |
44002 | 传递的参数为空 | |
47001 | 传递的参数格式不对 | |
48001 | 小程序无该 api 权限 | |
61010 | 用户访问记录超时(用户未在近两小时访问小程序) | |
9410009 | 测试额度已耗尽 | |
其他 | 系统错误 |
# 请求数据示例
const cloud = require('wx-server-sdk');
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
});
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.riskControl.getUserRiskRank({
appid: 'wx*******',
openid: '*****',
scene: 1,
mobileNo: '12345678',
bankCardNo: '******',
certNo: '*******',
clientIp: '******',
emailAddress: '***@qq.com',
extendedInfo: '',
});
return result;
} catch (err) {
return err;
}
};
# 返回数据示例
{
"errCode": 0,
"errMsg": "openapi.riskControl.getUserRiskRank:ok",
"riskRank": 0,
"unoinId": 123456
}