数美天网-诈骗导流识别#


版权所有 翻版必究


诈骗导流识别

诈骗导流识别#

事件接口#

请求URL:#

集群URL支持产品列表
北京http://api-skynet-bj.fengkongcloud.com/v4/event天网风险识别
美国(弗吉尼亚)http://api-skynet-fjny.fengkongcloud.com/v4/event天网风险识别
新加坡http://api-skynet-xjp.fengkongcloud.com/v4/event天网风险识别
欧洲(法兰克福)http://api-skynet-eur.fengkongcloud.com/v4/event天网风险识别

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

1s

请求参数:#

请求body = 通用请求参数 + 事件特有参数 (放在data字段下)

通用的请求参数:#

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

参数名称类型参数说明是否必传规范
accessKeystring接口认证密钥
用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看
必传参数数美分配
appIdstring应用ID,用于区分相同公司的不同应用必传参数该参数传递值可与数美协商。
当公司app存在多个马甲包,分下面两种情况:
1. 马甲包账号互通,不同马甲包数据传入不同的appId,tokenId保持一致
2. 马甲包账号独立,不同马甲包数据传入不同的appId,tokenId必须不同
eventIdstring事件ID,用于标识事件类型。必传参数不同的事件对应不同的策略,不同的事件输入参数可能会有细微的差别,请对应按照各事件详细传参说明
datajson_object请求的数据内容,事件特有参数可以放入data下传入必传参数请求的数据内容,最长10MB,详见data参数
其中,data的内容如下:
参数名称类型参数说明是否必传规范
tokenIdstring用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值必传参数注意点:
1. tokenId传入业务系统中的用户ID,务必保证接入数美全部事件相同用户传入的用户ID值一致且唯一
2. 如果公司主体下存在多个应用且需要按应用区分账号,即相同用户ID在不同应用中代表不同用户。则建议在传入的用户ID之前拼接应用标识作为tokenId传入,达到区分账号体系的目的。
3. 如果没有区分需求,则直接将用户ID传入tokenId字段即可
4. 如果传入错误,会导致系统认为是不同账号,账号的行为无法关联,导致识别不准确
ipstring当前业务事件发生时的客户端公网ipv4地址必传参数非内网ip
timestampint64当前业务事件发生时的时间戳,单位为毫秒(ms)必传参数
deviceIdstring数美设备指纹标识,由数美SDK生成强烈建议数美设备指纹标识,用于用户行为分析。
注:
1. 接入数美SDK前的版本,无法获取到deviceId的情况下,deviceId传空“”即可;
2. 直接传输getDeviceId获取到的原始字段,不需要解密
osstring应用端操作系统类型强烈建议可选值:android、ios、weapp、web
appVersionstring应用版本号强烈建议传入当前应用或服务正在使用的版本号,格式为3个点4段数字,每段数字最多4位,例如3.2.1.1234。不足4段的请补0,例如2.1.5传入2.1.5.0。多于4段的取前4段,例如2.1.5.1.1传入2.1.5.1
activityIdstring营销活动id强烈建议建议传入对应营销活动标识id
userAgentstring用户代理强烈建议
countryCodestring手机用户的国家代码强烈建议中国大陆区手机号填写0086非中国大陆区手机号填写国家代码例如:美国填写0001、安道尔0376、巴哈马1242
phoneMd5string手机号的Md5,32位小写加密串建议
phoneSha256string手机号的Sha256加密串建议
rolestring角色强烈建议可选值(强校验取值只能为空、ADMINHOST);HOST代表主播,针对主播,将会放开多开、PC模拟器规则以及关联频度策略阈值,以保证主播的正常体验和使用。
levelint用户等级,针对不同等级的用户可配置不同拦截策略强烈建议可选值:0,1,2,3,4分别对应:
0:最低级用户,典型如新注册、完全不活跃或等级为0的用户等
1:较低级用户,典型如低活跃或低等级用户等
2:中等级用户,典型如具备一定活跃或等级中等的用户等
3:较高级用户,典型如高活跃或高等级用户等4:最高级用户,典型如付费用户、VIP用户、可考虑放过的用户等
vdatajson微行为数据传入字段建议
extrajson用户自定义数据建议如无必要,不传
passThroughjson用户自定义透传字段建议如无必要,不传

返回结果#

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

参数名称类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
3000:运营商错误
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功 QPS超限 参数不合法 服务失败 余额不足 无权限操作
requestIdstring请求标识请求唯一标识,用于排查问题和后续效果优化,强烈建议保存
riskevelstring当前事件的处置建议PASS:通过
REVIEW:审核
REJECT:拒绝
VERIFY:验证
detailjson_object风险详情信息,详情见下文请见《detail结果详情》表
tokenProfileLabelsjson_array账号属性标签见下面详情内容,仅在服务开通时返回
tokenRiskLabelsjson_array账号风险标签见下面详情内容,仅在服务开通时返回

其中

1)detail结果的详情内容

返回结果参数名参数类型参数说明规范
descriptionstring当前事件的风险描述
modelstring规则标识,命中的最高优先级规则标识
hitsJson array事件命中的所有规则标识hits中每个字段都是一个object,详见《hits结果详情信息》
ip_countrystringip归属地国家
ip_provincestringip归属地省份
ip_citystringip归属地城市
verifyTypestring当处置建议为VERIFY时,返回verifyTypeUPSMS:上行短信验证码
DOWNSMS:下行短信验证码
CAPTCHA:验证码(点选或滑动等)
SEQUENCE:语序验证(点选或输入)
SPATIAL:空间逻辑推理
FACE:人脸检测
DELAY:延时交易
machineAccountRiskjson账号历史打黑信息只有当前账号历史被打入账号黑库后,账号的相关流水才会返回该结构体
smidstring设备唯一标识需要传入deviceId字段且联系数美开通配置后,才会返回该字段

其中,hits结果详情的内容如下:

返回结果参数名参数类型参数说明规范
descriptionstring当前事件的风险描述
modelstring规则标识
riskLevelstring当前事件的处置建议PASS:通过
REVIEW:审核
REJECT:拒绝
VERIFY:验证
verifyTypestring当处置建议为VERIFY时,返回verifyTypeUPSMS:上行短信验证码
DOWNSMS:下行短信验证码
CAPTCHA:验证码(点选或滑动等)
SEQUENCE:语序验证(点选或输入)
SPATIAL:空间逻辑推理
FACE:人脸检测
DELAY:延时交易

其中,machineAccountRisk详情的内容如下:

返回结果参数名参数类型参数说明规范
tokenSampleLastTsint64最近打黑时间,毫秒级如:"tokenSampleLastTs": 1683026613000
tokenSampleDescstring历史打黑策略的description如:"tokenSampleDesc": "高风险设备:IP异常聚集"

其中标签类返回字段

1)tokenProfileLabels的详情内容

返回结果参数名参数类型参数说明规范
label1string一级标签展示账号属性标签的一级标签。
label2string二级标签展示账号属性标签的二级标签。
label3string三级标签展示账号属性标签的三级标签。
descriptionstring风险描述展示账号属性标签的中文描述。
timestampint64最近一次命中策略的时间最近一次命中策略的时间
detailjson_object证据描述证据细节

2)tokenRiskLabels的详情内容

返回结果参数名参数类型参数说明规范
label1string一级标签展示账号风险标签的一级标签。
label2string二级标签展示账号风险标签的二级标签。
label3string三级标签展示账号风险标签的三级标签。
descriptionstring风险描述展示账号风险标签的中文描述。
timestampint64最近一次命中策略的时间最近一次命中策略的时间
detailjson_object证据描述证据细节

3) 三级标签说明

一级标签一级标识二级标签二级标识三级标签三级标识
risk_register_token风险注册账号monkey_register_token机器注册账号monkey_register_token机器注册账号
risk_login_token风险登录账号environment_change_token环境跳变账号unusual_device_login_token异常设备登录账号
risk_login_token风险登录账号environment_change_token环境跳变账号unusual_region_login_token异常地域登录账号
risk_login_token风险登录账号account_takeover_token撞库盗号账号
account_takeover_token
撞库盗号账号
risk_login_token风险登录账号monkey_login_token机器登录账号monkey_login_token机器登录账号
marketing_cheating_token营销作弊账号fission_cheat_token裂变作弊账号fission_cheat_token裂变作弊账号
marketing_cheating_token营销作弊账号rank_cheat_token刷榜作弊账号rank_cheat_token刷榜作弊账号
marketing_cheating_token营销作弊账号task_cheat_token任务作弊账号task_cheat_token任务作弊账号
marketing_cheating_token营销作弊账号seckill_cheat_token机器秒杀作弊账号seckill_cheat_token机器秒杀作弊账号
marketing_cheating_token营销作弊账号risk_discount_token薅优惠账号risk_discount_token薅优惠账号
marketing_cheating_token营销作弊账号consume_stock_token占库存/占座账号consume_stock_token占库存/占座账号
data_stealing_token数据盗爬账号data_steal_token数据盗爬账号data_steal_token数据盗爬场账号
ad_scam_token诈骗导流账号net_scam_token网络诈骗账号net_scam_token网络诈骗账号
ad_scam_token诈骗导流账号user_digging_token竞品挖人账号user_digging_token竞品挖人账号
ad_scam_token诈骗导流账号ad_diversion_token广告导流账号ad_diversion_token广告导流账号
risk_group_token高危团伙账号risk_group_token高危团伙账号risk_group_token高危团伙账号
risk_content_token风险内容账号porn_token色情内容账号porn_token色情内容账号
risk_content_token风险内容账号politics_token涉政内容账号politics_token涉政内容账号
other_risk_token其他可疑账号monkey_token机器操控账号monkey_token机器操控账号
other_risk_token其他可疑账号high_frequency_token异常高频账号high_frequency_token异常高频账号
other_risk_token其他可疑账号abnormal_active_token异常活跃账号abnormal_active_token异常活跃账号
other_risk_token其他可疑账号discrete_region_token地域离散账号discrete_region_token地域离散账号
other_risk_token其他可疑账号abnormal_relation_token异常关联账号abnormal_relation_token异常关联账号

事件列表#

行业场景事件eventId规范
通用通用注册register参数详情
通用通用登录login参数详情

事件详细API#

注册事件 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
typestring注册方式: 包括手机号码一键注册、手机号验证码注册、第三方授权、用户名密码注册必传字段可选值:
phoneOnePass:手机号一键注册、手机号验证码注册
signupPlatform、第三方授权
userPassword用户名密码注册
hashPasswordstring加密后的用户密码强烈建议可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。
isPhoneExistint该手机号是否已经被注册强烈建议可选值:01若注册方式为手机号注册,且该手机号已经被注册过,则传入1,否则传入0.
guestIdstring游客账号强烈建议在游客账号绑定成真实账号时,tokenId传入真实账号,guestId传入游客账号,长度限制在64个字符以内。
nickNamestring用户账户昵称建议
clickIdstring点击id强烈建议(渠道假量场景,关联渠道点击事件使用)
腾讯平台:传入点击回调中的click_id即可
巨量平台:传入点击回调中的CALLBACK_PARAM即可
signupPlatformstring第三方注册平台,如果本平台直接注册,可以不传建议可选值:qq、weibo、weixin、alipay、taobao、facebook、twitter
emailstring注册使用邮箱建议
sexstring用户性别,没有则不传建议可选值:male,female
isSignupPlatformPhoneint该手机号是否是第三方授权平台手机号建议可选值:01若手机号为第三方授权平台绑定的手机号,则传入1,否则传入0.

登录事件 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
typestring登录方式,包括:本机号码一键登录、手机号密码登录、手机号验证码登录、用户名密码登录、生物识别(指纹、人脸、声音锁)登录必传字段可选值:
fastLogin:快速登录
phoneOneLogin:本机号码一键登录
phonePassword:手机号密码登录
phoneMessage:手机号验证码登录signupPlatform:第三方授权登录
userPassword:用户名密码登录
biometric:生物识别
hashPasswordstring加密后的用户密码强烈建议可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。
subTokenIdstring账号的子账号强烈建议某些特殊的场景主账号有多个子账号(游戏场景不同区服)
roleIdstring当前业务登录用户角色,游戏行业特殊字段强烈建议
validint用户名密码验证结果建议可选值:
1:成功
0:失败

示例:#

请求示例:#

{
"accessKey": "XXXXXXXX",
"appId": "default",
"data": {
"deviceId": "202202110150160d1404c60f8a645c49786a53435c6b64010242529c497de4",
"ip": "87.119.224.144",
"isTokenSeperate":0,
"timestamp":1647570483887,
"tokenId": "1157893898",
"email":"iGa.mie.123+test@gmail.com",
"phoneMd5":"788abf53c451e0e7f6ff772b79784af3",
"nickName":"hhh"
},
"eventId": "register"
}

同步返回示例:#

{
"code": 1100,
"message": "成功",
"requestId": "4176ccb9803096b26b51e5d33e38838d",
"riskLevel": "PASS",
"score": 0,
"tokenRiskLabels": [
{
"label1": "ad_scam_token",
"label2": "ad_diversion_token",
"label3": "ad_diversion_token",
"description": "诈骗&引流账号:广告导流账号:广告导流账号",
"timestamp": null
},
{
"label1": "other_risk_token",
"label2": "high_frequency_token",
"label3": "high_frequency_token",
"description": "其他可疑账号识别:异常高频账号:异常高频账号",
"timestamp": null
},
{
"label3": "abnormal_active_token",
"description": "其他可疑账号识别:异常活跃账号:异常活跃账号",
"timestamp": null,
"label1": "other_risk_token",
"label2": "abnormal_active_token"
},
{
"timestamp": null,
"label1": "other_risk_token",
"label2": "discrete_region_token",
"label3": "discrete_region_token",
"description": "其他可疑账号识别:地域离散账号:地域离散账号"
},
{
"label1": "other_risk_token",
"label2": "abnormal_relation_token",
"label3": "abnormal_relation_token",
"description": "其他可疑账号识别:异常关联账号:异常关联账号",
"timestamp": null
},
{
"description": "其他可疑账号识别:机器操控账号:机器操控账号",
"timestamp": null,
"label1": "other_risk_token",
"label2": "monkey_token",
"label3": "monkey_token"
},
{
"label3": "monkey_register_token",
"description": "风险注册登录账号识别:机器注册账号:机器注册账号",
"timestamp": null,
"label1": "risk_register_login_token",
"label2": "monkey_register_token"
}
],
"tokenProfileLabels": [],
"detail": {
"description": "正常",
"model": "M1000"
}
}

账号查询接口#

请求URL:#

集群URL支持产品列表
北京集群http://api-tianxiang-bj.fengkongcloud.com/tianxiang/v4风险查询
新加坡集群http://api-tianxiang-xjp.fengkongcloud.com/tianxiang/v4风险查询
法兰克福集群http://api-tianxiang-eur.fengkongcloud.com/tianxiang/v4风险查询
弗吉尼亚集群http://api-tianxiang-fjny.fengkongcloud.com/tianxiang/v4风险查询

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

1s

请求参数:#

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

请求参数名类型参数说明是否必传规范
accessKeystring接口认证密钥
用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看
必传参数数美分配
datajson_object请求的数据内容必传参数请求的数据内容,最长10MB,详见data参数
其中,data的内容如下:
请求参数名类型参数说明是否必传规范
tokenIdstring用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值不能为空注意点:
1. tokenId传入业务系统中的用户ID,务必保证接入数美全部事件相同用户传入的用户ID值一致且唯一
2. 如果公司主体下存在多个应用且需要按应用区分账号,即相同用户ID在不同应用中代表不同用户。则建议在传入的用户ID之前拼接应用标识作为tokenId传入,达到区分账号体系的目的。
3. 如果没有区分需求,则直接将用户ID传入tokenId字段即可
4. 如果传入错误,会导致系统认为是不同账号,账号的行为无法关联,导致识别不准确

返回结果#

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

参数名称参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
3000:运营商错误
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功 QPS超限 参数不合法 服务失败 余额不足 无权限操作
requestIdstring请求标识请求唯一标识,用于排查问题和后续效果优化,强烈建议保存
tokenLabelsjson_object账号标签信息见下面详情内容,仅在tokenId传入且服务开通时返回
tokenProfileLabelsjson_array账号属性标签见下面详情内容,仅在tokenId传入且服务开通时返回
tokenRiskLabelsjson_array账号风险标签见下面详情内容,仅在tokenId传入且服务开通时返回

其中

1)tokenLabels的详情内容

返回结果参数名参数类型参数说明规范
machine_account_riskjson_object机器控制相关风险
UGC_account_riskjson_objectUGC内容相关风险
scene_account_riskjson_object场景账号风险特殊场景才可取到,如航司等

machine_account_risk的详情内容如下:

返回结果参数名参数类型参数说明规范
b_machine_control_tokenidint机器账号0:非机器控制账号1:机器控制账号
b_machine_control_tokenid_last_tsint机器账号时间
b_offer_wall_tokenidint积分墙账号0:非积分墙账号1:积分墙账号
b_offer_wall_tokenid_last_tsint积分墙账号时间

UGC_account_risk的详情内容如下:

返回结果参数名参数类型参数说明规范
b_politics_risk_tokenidint涉政风险0:暂未发现涉政风险1:存在涉政风险
b_politics_risk_tokenid_last_tsint涉政风险时间
b_sexy_risk_tokenidint色情风险0:暂未发现色情风险1:存在色情风险
b_sexy_risk_tokenid_last_tsint色情风险时间
b_advertise_risk_tokenidint广告风险0:暂未发现广告风险1:存在广告风险
b_advertise_risk_tokenid_last_tsint广告风险时间

scene_account_risk的详情内容如下:

返回结果参数名参数类型参数说明规范
i_tout_risk_tokenidint航司占座账号0:非航司占座账号1:航司占座账号
i_tout_risk_tokenid_last_tsint航司占座时间

其中标签类返回字段

1)tokenProfileLabels的详情内容

返回结果参数名参数类型参数说明规范
label1string一级标签展示账号属性标签的一级标签。
label2string二级标签展示账号属性标签的二级标签。
label3string三级标签展示账号属性标签的三级标签。
descriptionstring风险描述展示账号属性标签的中文描述。
timestampint64最近一次命中策略的时间最近一次命中策略的时间
detailjson_object证据描述证据细节

2)tokenRiskLabels的详情内容

返回结果参数名参数类型参数说明规范
label1string一级标签展示账号风险标签的一级标签。
label2string二级标签展示账号风险标签的二级标签。
label3string三级标签展示账号风险标签的三级标签。
descriptionstring风险描述展示账号风险标签的中文描述。
timestampint64最近一次命中策略的时间最近一次命中策略的时间
detailjson_object证据描述证据细节

示例:#

请求示例:#

{
"accessKey": "xxxxxxxxxxxxxxxxxxxxxxxxx",
"data": {
"tokenId": "ceshitokenId"
}
}

同步返回示例:#

{
"code": 1100,
"message": "成功",
"profileExist": 1,
"requestId": "7a5445716f0581c2ab1d381a6af4d1b8",
"tokenLabels": {
"machine_account_risk": {
"b_machine_control_tokenid": 1,
"b_machine_control_tokenid_last_ts": 1587711321232,
"b_offer_wall_tokenid": 1,
"b_offer_wall_tokenid_last_ts": 1587711321232
},
"UGC_account_risk": {
"b_politics_risk_tokenid": 1,
"b_politics_risk_tokenid_last_ts": 1587711321232,
"b_sexy_risk_tokenid": 1,
"b_sexy_risk_tokenid_last_ts": 1587711321232,
"b_advertise_risk_tokenid": 1,
"b_advertise_risk_tokenid_last_ts": 1587711321232
},
"scene_account_risk": {
"i_tout_risk_tokenid": 1,
"i_tout_risk_tokenid_last_ts": 1587711321232
},
"account_active_info": {
"i_tokenid_first_active_timestamp": 1587711321232,
"i_tokenid_active_days_7d": 5,
"i_tokenid_active_days_4w": 5
},
"account_freq_info": {
"i_tokenid_login_cnt_1d": 5,
"i_tokenid_login_cnt_7d": 5
},
"account_relate_info": {
"i_tokenid_relate_smid_cnt_1d": 5,
"i_tokenid_relate_smid_cnt_7d": 5,
"i_tokenid_relate_ip_city_cnt_1d": 5,
"i_tokenid_relate_ip_city_cnt_7d": 5
},
"account_common_info": {
"s_tokenid_relate_smid_info_map_4w": [
{
"smid": "xxxx1",
"days": "3"
},
{
"smid": "xxxx2",
"days": "5"
},
{
"smid": "xxxx3",
"days": "10"
}
],
"s_tokenid_relate_ip_city_info_map_4w": [
{
"city": "北京",
"days": "3"
},
{
"city": "长沙",
"days": "5"
},
{
"city": "武汉",
"days": "10"
}
]
}
},
"tokenProfileLabels": [
{
"label1": "age_gender",
"lable2": "token_age",
"label3": "minor_token",
"description": "年龄性别:年龄:未成年人",
"timestamp": 1634732525000,
"detail": {
}
}
],
"tokenRiskLabels": [
{
"label1": "risk_device_token",
"label2": "b_cloud_token_device",
"label3": "b_cloud_token_device",
"description": "风险设备账号:云手机账号:云手机账号",
"timestamp": 1634732525000,
"detail": {
}
},
{
"label1": "risk_device_token",
"label2": "b_hook_token",
"label3": "b_hook_token",
"description": "风险设备账号:hook设备:hook设备",
"timestamp": 1634732525000,
"detail": {
}
}
]
}

文本接口#

请求URL:#

集群URL支持产品列表
北京http://api-text-bj.fengkongcloud.com/text/v4诈骗导流识别
上海http://api-text-sh.fengkongcloud.com/text/v4诈骗导流识别
广州http://api-text-gz.fengkongcloud.com/text/v4诈骗导流识别
美国(弗吉尼亚)http://api-text-fjny.fengkongcloud.com/text/v4诈骗导流识别
新加坡http://api-text-xjp.fengkongcloud.com/text/v4诈骗导流识别

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

1s

请求参数:#

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

请求参数名类型参数说明是否必传规范
accessKeystring接口认证密钥由数美提供
appIdstring应用标识用于区分应用,可选值如下:default:默认应用
额外应用值需数美单独分配提供。
当公司app存在多个马甲包,分下面两种情况:
1. 马甲包账号互通,不同马甲包数据传入不同的appId,tokenId保持一致
2. 马甲包账号独立,不同马甲包数据传入不同的appId,tokenId必须不同
eventIdstring事件标识可选值如下:额外事件值需数美单独分配提供
typestring检测的风险类型可选值:DEFAULT :默认值(包含:涉政、暴恐、违禁、色情、辱骂、广告、灌水、无意义、隐私、广告法、黑名单)
FRUAD :网络诈骗
UNPOACH:高价值用户防挖
以上type可以下划线组合,如:DEFAULT_FRUAD
datajson_object请求的数据内容最长1MB,详见data参数
businessTypestring检测的业务类型可选值:MINOR:未成年人

其中,data的内容如下:

请求参数名类型参数说明是否必传规范
textstring需要检测的文本(200字内效果最佳)文本字数上限2000字,若传递nickname字段,则会同时校验文本+昵称内容。注意:有超过2000字以上文本内容建议联系数美协商
tokenIdstring用用户账号标识, 建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值注意点:
1. tokenId传入业务系统中的用户ID,务必保证接入数美全部事件相同用户传入的用户ID值一致且唯一
2. 如果公司主体下存在多个应用且需要按应用区分账号,即相同用户ID在不同应用中代表不同用户。则建议在传入的用户ID之前拼接应用标识作为tokenId传入,达到区分账号体系的目的。
3. 如果没有区分需求,则直接将用户ID传入tokenId字段即可
4. 如果传入错误,会导致系统认为是不同账号,账号的行为无法关联,导致识别不准确
nicknamestring用户昵称校验昵称内容风险
ipstringip地址发送该文本的的用户公网ipv4地址
deviceIdstring数美设备标识数美设备指纹生成的设备唯一标识
extrajson_object辅助参数用于辅助文本检测的相关信息,详见extra参数

data 中 extra数组每个元素的内容如下:

请求参数名类型参数说明是否必传规范
receiveTokenIdstring消息接收者的tokenIdeventId值为 message 时必传由数字、字母、下划线、短杠组成的长度小于等于64位的字符串
topicstring可为话题编号、书评区编号、论坛帖子编号eventId值为 article 必传
atIdstringeventId值为 groupChat 必传用户在公开场景可以相互@,该参数用于传入被@用户的tokenId由数字、字母、下划线、短杠组成的长度小于等于64位的字符串
roomstring直播间/游戏房间编号eventId值为 groupChat 时必传
levelint用户等级可选值:
0:最低级用户,典型如新注册、完全不活跃或等级为0的用户等;
1:较低级用户,典型如低活跃或低等级用户等;
2:中等级用户,典型如具备一定活跃或等级中等的用户等;
3:较高级用户,典型如高活跃或高等级用户等;
4:最高级用户,典型如付费用户、VIP用户等 可选值:
rolestring用户角色用于区分直播/游戏行业不同角色的用户,可选值(默认为普通用户):
ADMIN :房管/管理员
HOST :主播
SYSTEM :系统
USER :普通用户
sexint性别用于用户性别;
可选值: 0:男性、1:女性、2:性别不明
passThroughJson透传字段该字段内容会随着返回值一起返回

返回结果:#

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

返回结果参数名参数类型参数说明是否必返规范
codeint返回码1100:成功1901:QPS超限1902:参数不合法1903:服务失败9100:余额不足9101:无权限操作
messagestring返回码描述和code对应:成功QPS超限参数不合法服务失败余额不足无权限操作
requestIdstring请求标识本次请求数据的唯一标识,用于问题排查和效果优化,强烈建议保存
riskLevelstring处置建议可能返回值:PASS:正常,建议直接放行REVIEW:可疑,建议人工审核REJECT:违规,建议直接拦截
riskLabel1string一级风险标签一级风险标签,当riskLevel为PASS时返回normal
riskLabel2string二级风险标签二级风险标签,当riskLevel为PASS时为空
riskLabel3string三级风险标签三级风险标签,当riskLevel为PASS时为空
riskDescriptionstring风险原因当riskLevel为PASS时为"正常"
riskDetailjson_object风险详情风险详情,详见riskDetail参数
tokenLabelsjson object辅助信息账号风险画像标签信息见下面详情内容。详见tokenLabels参数
auxInfojson_object辅助信息详见auxlnfo参数
allLabelsjson_array辅助信息命中的所有风险标签以及详情信息。详见allLabels参数
businessLabelsJson_array辅助信息命中的所有业务标签以及详细信息。详见businessLabels参数
tokenProfileLabelsjson_array辅助信息属性账号类标签。详见账号标签参数
tokenRiskLabelsjson_array辅助信息风险账号类标签。详见账号标签参数

其中auxInfo字段如下:

参数名称类型参数说明是否必返规范
filteredTextstring辅助信息敏感词被替换为*后的文本(该参数仅在命中敏感词时存在)
语境模型,联系方式相关风险不返回该字段
passThroughjson_object透传字段该字段内容与请求参数data中extra的passThrough的值相同。
contactResultjson_array辅助信息联系方式识别结果,包含识别出的微信、微博、QQ、手机号的字符串类型和内容。 详见contactResult参数

auxInfo中,contactResult数组每个元素的内容如下:

参数名称类型参数说明是否必返规范
contactTypeint辅助信息联系方式类型,可选值区间【0-3】,详情如下:0: 手机号
1: QQ号
2: 微信号
3: 微博号
contactStringstring辅助信息联系方式串

其中,riskDetail的内容如下:

返回结果参数名参数类型参数说明是否必返备注
matchedListsjson_array辅助信息命中的客户自定义名单列表。详 见matchedLists参数
riskSegmentsjson_array辅助信息,高风险内容片段检测文本包含涉政、暴恐、违禁、广告法等风险内容的时候存在详见riskSegments参 数

riskDetail中,matchedLists数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
namestring辅助信息命中的名单名称
wordsjson_array辅助信息命中的敏感词数组。详见words参数

matchedLists中,words数组每个元素的内容如下:

返回结果参数名参数类型参数说明是否必返规范
wordstring辅助信息命中的敏感词
positionint_array辅助信息敏感词所在位置

riskDetail中,riskSegments的内容如下:

返回结果参数名参数类型参数说明是否必返规范
segmentstring辅助信息高风险内容片段
positionint_array辅助信息高风险内容片段所在位置

其中,tokenLabels的详情内容:

返回结果参数名参数类型参数说明是否必返规范
UGC_account_riskjson_object辅助信息UGC内容相关风险。详见UGC_account_risk参数

tokenLabels中,UGC_account_risk的详情内容如下:

返回结果参数名参数类型参数说明是否必返规范
sexy_risk_tokenidfloat辅助信息色情账号风险分取值区间[0-1]

其中,allLabels的内容如下:

返回结果参数名参数类型参数说明是否必返规范
riskLabel1stringallLabels不为空时必返一级风险标签
riskLabel2stringallLabels不为空时必返二级风险标签
riskLabel3stringallLabels不为空时必返三级风险标签
riskDescriptionstringallLabels不为空时必返风险原因
probabilityfloat置信度可选值在0~1之间,值越大,可信度越高
注意:allLabels不为空时必返
riskDetailjson_object风险详情格式与上层riskDetail结构相同
注意:allLabels不为空时必返
riskLevelstring风险等级取值:REJECT 违规REVIEW 可疑

其中,businessLabels的内容如下:

返回结果参数名参数类型参数说明是否必返规范
businessLabel1stringbusinessLabels不为空时必返一级标签
businessLabel2stringbusinessLabels不为空时必返二级标签
businessLabel3stringbusinessLabels不为空时必返三级标签
businessDescriptionstringbusinessLabels不为空时必返标签描述
probabilityfloatbusinessLabels不为空时必返可选值在0~1之间,值越大,可信度越高置信度
businessDetailJson_object业务详情businessLabels不为空时必返

其中,tokenProfileLabels、tokenRiskLabels的内容如下:

返回结果参数名参数类型参数说明是否必返规范
label1string一级标签
label2string二级标签
label3string三级标签
descriptionstring标签描述
timestampInt打标签时间戳13位Unix时间戳,单位:毫秒

一级标签的内容如下:

一级标签一级标识类型规范
涉政politics监管标签type值为DEFAULT
暴恐violence监管标签type值为DEFAULT
色情porn监管标签type值为DEFAULT
违禁ban监管标签type值为DEFAULT
辱骂abuse监管标签type值为DEFAULT
广告法ad_law监管标签type值为DEFAULT
广告ad监管标签type值为DEFAULT
黑名单blacklist监管标签type值为DEFAULT
无意义meaningless监管标签type值为DEFAULT
隐私privacy监管标签type值为DEFAULT
网络诈骗fraud监管标签type值为FRUAD、UNPOACH
未成年人minor业务标签businessType值为MINOR

示例 #

请求示例#

{
"accessKey":"*************",
"appId":"default",
"eventId":"text",
"type":"DEFAULT",
"businessType":"MINOR",
"data":
{
"text":"我12岁了,你呢,我要去天安门看毛主席照片",
"tokenId":"4567898765jhgfdsa",
"ip":"118.89.214.89",
"deviceId":"*************",
"nickname":"***********",
"extra":
{
"topic":"12345",
"atId":"username1",
"room":"ceshi123",
"receiveTokenId":"username2",
"level":1,
"role":"ADMIN"
}
}
}

返回示例#

{
"code":1100,
"message":"成功",
"requestId":"cfd98ce4510efd74e3a5182d2b752ee9",
"riskLevel":"REJECT",
"riskLabel1":"politics",
"riskLabel2":"shezheng",
"riskLabel3":"shezheng",
"riskDescription":"涉政:涉政:涉政",
"riskDetail":{
},
"allLabels":[
{
"probability":1,
"riskDescription":"涉政:国内领导人:历任国级领导",
"riskDetail":{
"riskSegments":[
{
"position":[
16,
17,
18
],
"segment":"毛主席"
},
{
"position":[
16,
17,
18
],
"segment":"毛主席"
}
]
},
"riskLabel1":"politics",
"riskLabel2":"guoneilingdaoren",
"riskLabel3":"lirenguojilingdao",
"riskLevel":"REJECT"
},
{
"probability":1,
"riskDescription":"涉政:涉政:涉政",
"riskDetail":{
"riskSegments":[
{
"position":[
12,
13,
14
],
"segment":"天安门"
},
{
"position":[
16,
17,
18
],
"segment":"毛主席"
}
]
},
"riskLabel1":"politics",
"riskLabel2":"shezheng",
"riskLabel3":"shezheng",
"riskLevel":"REJECT"
},
{
"probability":1,
"riskDescription":"涉政:核心领导:毛泽东",
"riskDetail":{
"riskSegments":[
{
"position":[
16,
17,
18
],
"segment":"毛猪稀"
},
{
"position":[
16,
17,
18,
16,
17,
18
],
"segment":"毛猪西"
},
{
"position":[
16,
17,
18
],
"segment":"猫主席"
},
{
"position":[
16,
17,
18
],
"segment":"猫朱熹"
},
{
"position":[
16,
17,
18
],
"segment":"毛主席"
}
]
},
"riskLabel1":"politics",
"riskLabel2":"hexinlingdao",
"riskLabel3":"maozedong",
"riskLevel":"REJECT"
}
],
"auxInfo":{
"contactResult":[
{
"contactString":"你呢",
"contactType":3
}
],
"filteredText":"我12岁了,你呢,我要去***看***照片"
},
"businessLabels":[
{
"businessDescription":"未成年人:未成年人:未成年人",
"businessLabel1":"minor",
"businessLabel2":"minor",
"businessLabel3":"clear",
"businessDetail":{},
"probability":1
}
]
}

在线咨询