数美智能文本识别产品API接口文档#

请求参数#

请求URL:#

集群URL支持产品列表
北京http://api-text-bj.fengkongcloud.com/v2/saas/anti_fraud/text中文文本
上海http://api-text-sh.fengkongcloud.com/v2/saas/anti_fraud/text中文文本
广州http://api-text-gz.fengkongcloud.com/v2/saas/anti_fraud/text中文文本
美国(弗吉尼亚)http://api-text-fjny.fengkongcloud.com/v2/saas/anti_fraud/text中文文本
新加坡http://api-text-xjp.fengkongcloud.com/v2/saas/anti_fraud/text中文文本
印度https://api-text-yd.fengkongcloud.com/v2/saas/anti_fraud/text中文文本

字符编码格式:#

UTF-8字符集编码

请求方法:#

POST

建议超时时长:#

1s

请求参数:#

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

请求参数名类型参数说明是否必传规范
accessKeystring接口认证密钥Y由数美提供
appIdstring应用标识Y用于区分应用,需要联系数美开通,请使用数美单独提供的传值为准
typestring检测的风险类型或者场景Y可选值:
ZHIBO:直播
ECOM:电商
GAME:游戏
NEWS:新闻资讯
FORUM:论坛
SOCIAL:社交
QQ:QQ
NOVEL:小说
TEXTRISK:默认值(包含:
涉政、暴恐、违禁、色情、辱骂、广告、隐私、广告法)
FRUAD:网络诈骗
UNPOACH:高价值用户防挖

TEXTMINOR: 未成年人
以上type可以下划线组合,如:ZHIBO_TEXTRISK_FRUAD
datajson_object请求的数据内容Y最长1MB, 详见data参数
其中,data的内容如下:
请求参数名类型参数说明是否必传规范
textstring需要检测的文本Y文本字数上限1万字,超过1万字只截取前1万字进行识别
若传递nickname字段,则会同时校验文本+昵称内容。
tokenIdstring用户账号标识, 建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。
如无用户uid的场景建议使用唯一的数据标识传值
Y由数字、字母、下划线、短杠组成的长度小于等于64位的字符串
genderint用户性别N可选值
0:女性
1:男性
channelstring业务场景N渠道表配置
nicknamestring用户昵称,强烈建议传递此参数,几乎所有平台的恶意用户都会通过昵称散播垃圾信息,存在涉政违禁和导流信息等风险,长度限制150字符,超出部分会被截断N
ipstringip地址,该参数用于IP维度的用户行为分析,同时可用于比对数美IP黑库N
deviceIdstring数美设备标识,强烈建议传入该参数,数美设备指纹标识,用于用户行为分析。当恶意用户篡改mac、imei等设备信息时,使用deviceId能够发现和识别此类恶意行为,同时可用于比对数美设备指纹黑名单N
receiveTokenIdstring接收者的tokenId,私聊场景必选N
levelint用户等级,针对不同等级的用户可配置不同拦截策略N可选值:
0:最低级用户,典型如新注册、完全不活跃或等级为0的用户等;
1:较低级用户,典型如低活跃或低等级用户等;
2:中等级用户,典型如具备一定活跃或等级中等的用户等;
3:较高级用户,典型如高活跃或高等级用户等;
4:最高级用户,典型如付费用户、VIP用户等
registerTimeint帐号注册时间,强烈建议传递此参数,新注册帐号的异常操作风险较高N
friendNumint帐号好友数,社交场景强烈推荐传此参数,标识用户质量N
fansNumint帐号粉丝数,直播/社区场景强烈推荐传此参数,标识用户质量N
isPremiumUserint是否为优质(如付费)用户,配置不同等级,标识用户质量N可选值
0:默认值
1:优质账号
isTokenSeparateint是否区分不同应用下的账号N可选值
0:不区分
1:区分
默认值为0。
取值为1时不同应用下的账号体系各自独立,账号相关的策略特征在不同应用下单独统计和生效。
roomstring直播间/游戏房间编号,可针对单个房间制定不同的策略N
topicstring讨论的话题编号,可为书评区编号、论坛帖子编号。N
nickocrstring头像OCR识别出的文本内容N
imeistring用户android设备唯一标识,相比tokenId和IP,imei和mac更难被更换,当恶意用户使用多个不同账户和IP进作恶时,通过imei和mac能够有效关联识别此类恶意行为,同时可用于比对数美设备黑名单。N
macstring用户android设备唯一标识,相比tokenId和IP,imei和mac更难被更换,当恶意用户使用多个不同账户和IP进作恶时,通过imei和mac能够有效关联识别此类恶意行为,同时可用于比对数美设备黑名单。N
idfvstring用户iOS应用唯一标识,相比tokenId和IP,idfv不能被修改,当恶意用户使用多个不同账户和IP进行恶意行为时,使用idfv能够发现和识别此类恶意行为。N
idfastring用户iOS应用唯一标识,相比tokenId和IP,idfv不能被修改,当恶意用户使用多个不同账户和IP进行恶意行为时,使用idfv能够发现和识别此类恶意行为。N
passThroughjson_object该字段内容同返回结果一起返回N
dataIdstring数据标识N

返回结果#

返回结果#

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

参数名称类型参数说明是否必返规范
codeint返回码Y1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1905:字数超限
9101:无权限操作
messagestring返回码描述Y和code对应:
成功
QPS超限
参数不合法
服务失败
字数超限
无权限操作
requestIdstring请求标识Y本次请求数据的唯一标识,用于问题排查和效果优化,强烈建议保存
scoreint风险分数N取值范围[0,1000],分数越高风险越大
riskLevelstring处置建议N可能返回值:
PASS:正常,建议直接放行
REVIEW:可疑,建议人工审核
REJECT:违规,建议直接拦截
statusint提示服务是否超时Y可能返回值:
0:正常
501:超时
detailstring风险详情N详见detail参数
businessLabelsjson_array辅助信息Y命中的所有业务标签以及详细信息。详见businessLabels参数
tokenProfileLabelsjson_array辅助信息N属性账号类标签。详见账号标签参数
tokenRiskLabelsjson_array辅助信息N风险账号类标签。详见账号标签参数
unauthorizedTypestring辅助信息N未授权的type
其中detail字段如下:
参数名称类型是否必选说明
riskTypeintY风险类型:
0:正常
100:涉政
200:色情
210:辱骂
300:广告
340:网络诈骗
400:灌水
500:无意义
600:违禁
700:其他
720:黑账号
730:黑IP
800:高危账号
900:自定义
modelstringY规则标识,用来标识文本命中的策略规则。
注:该参数为旧版API返回参数,兼容保留,后续版本将去除,请勿依赖此参数,仅供参考
descriptionstringY策略规则风险原因描述
注:该参数为旧版API返回参数,兼容保留,后续版本将去除,请勿依赖此参数,仅供参考
descriptionV2stringN新版策略规则风险原因描述
注:该参数为新版API返回参数,过渡阶段只有新策略才会返回
isBlackTokenstringN该账号被画像策略标记为高危账号,可能取值:
1:高危账号
hitPositionstringN命中的敏感词在文本中的位置,从0开始计数
filteredTextstringN命中的敏感词被替换为*后的文本(该参数仅在命中敏感词时存在)
matchedListstringN命中敏感词所在的名单名称(该参数仅在命中敏感词时存在)
matchedItemstringN命中的具体敏感词(该参数仅在命中敏感词时存在)
contactResultjson_arrayN联系方式识别结果,包含识别出的微信、QQ、手机号的字符串类型和内容。详细信息见下表说明。详见联系方式
matchedDetailstringN命中的敏感词详细信息(需要和数美沟通开启相应策略),可以反序列化为json_array。详见matchedDetail
passThroughjson_objectN该字段是客户传入透传字段
sexy_risk_tokenidfloatN色情账号分,取值[0,1]
contextProcessedboolYtrue时说明该请求联系了上下文;
false时说明该请求未关联上下文,如需该功能,可与数美协商
contextTextstringY未开启联系上下文服务则只返回当前文本
contactResult中的每一项内容:
参数名称类型参数说明是否必返规范
contactTypeint辅助信息N联系方式类型,可选值区间【0-3】,详情如下:
0: 手机号
1: QQ号
2: 微信号
contactStringstring辅助信息N联系方式串
其中,matchedDetail内容:
参数名称类型参数说明是否必返规范
listIdstringY返回码
matchedFiledstring_arrayN标识昵称或文本内容命中了敏感词(该参数仅在命中敏感词时存在),可选值:
text:文本命中敏感词
nickname:昵称命中敏感词
namestringY命中敏感词所在的名单名称
organizationstringN命中名单所属的公司标识,其中“GLOBAL”为全局名单
wordsstring_arrayN命中的对应名单中的所有敏感词
wordPositionsjson_arrayN命中的对应名单中的所有敏感词及位置。详见wordPositions
wordPositions中的每一项内容:
参数名称类型参数说明是否必返规范
wordstring辅助信息N命中的敏感词
positionstring辅助信息N敏感词所在位置
其中,businessLabels的内容如下:
参数名称类型参数说明是否必返规范
businessLabel1stringbusinessLabels不为空必返Y一级业务标签
businessLabel2stringbusinessLabels不为空必返Y二级业务标签
businessLabel3stringbusinessLabels不为空必返Y三级业务标签
businessDescriptionstringbusinessLabels不为空必返Y标签描述
probabilityfloatbusinessLabels不为空必返
可选值在0~1之间,值越大,可信度越高
Y置信度
businessDetailJson_objectbusinessLabels不为空必返Y业务详情
其中,tokenProfileLabels、tokenRiskLabels的内容如下:
参数名称类型参数说明是否必返规范
label1string一级标签
label2string二级标签
label3string三级标签
descriptionstring标签描述
timestampInt打标签时间戳13位Unix时间戳,单位:毫秒

示例#

请求示例#

{
"accessKey":"*************",
"appId":"default",
"type":"ZHIBO",
"businessType":"MINOR",
"data":
{
"text":"加个好友吧 qq12345",
"tokenId":"4567898765jhgfdsa",
"channel":"text"
}
}

返回示例#

{
"businessLabels":[
],
"code":1100,
"detail":"{"contactResult":[{"contactString":"qq12345","contactType":2}],"contextProcessed":false,"contextText":"加个好友吧 qq12345","description":"广告:联系方式:联系方式","descriptionV2":"广告:联系方式:联系方式","filteredText":"加个好友吧 qq12345","matchedDetail":"[{\"listId\":\"e9d10f80db083704aa139c69411dd9a8\",\"matchedFiled\":[\"text\"],\"name\":\"测试zyk\",\"organization\":\"RlokQwRlVjUrTUlkIqOg\",\"wordPositions\":[{\"position\":\"8,9,10,11,12\",\"word\":\"12345\"},{\"position\":\"8,9,10\",\"word\":\"123\"},{\"position\":\"8,9,10,11\",\"word\":\"1234\"},{\"position\":\"10,11,12\",\"word\":\"345\"},{\"position\":\"9,10\",\"word\":\"23\"},{\"position\":\"8,9\",\"word\":\"12\"},{\"position\":\"9,10,11,12\",\"word\":\"2345\"},{\"position\":\"9,10,11\",\"word\":\"234\"},{\"position\":\"10,11\",\"word\":\"34\"},{\"position\":\"11,12\",\"word\":\"45\"}],\"words\":[\"12345\",\"123\",\"1234\",\"345\",\"23\",\"12\",\"2345\",\"234\",\"34\",\"45\"]}]","matchedItem":"12345,123,1234,345,23,12,2345,234,34,45","matchedList":"测试zyk","model":"MA000007015016003","riskType":300,"sexy_risk_tokenid":0,"tokenScore":4050}",
"message":"成功",
"requestId":"376c6607be790d70dc1cd40c61280ea0",
"riskLevel":"REJECT",
"score":650,
"status":0
}

在线咨询