请求参数#

请求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-xjp.fengkongcloud.com/text/v4
  • 弗吉尼亚:http://api-text-fjny.fengkongcloud.com/text/v4

请求方法#

POST

字符编码#

UTF-8

建议超时时间#

1s

请求参数#

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

参数名称类型是否必选说明
accessKeystringY公司密钥:用于权限认证,
开通账号服务时由数美提供
或使用开通邮箱登录数美后台右上角相关文档处查看
appIdstringY应用标识:
用于区分相同公司的不同应用数据
默认应用值:default
传递其他值时需联系数美服务协助开通
eventIdstringY事件标识:区分数据来源,针对场景调优策略,需以数美提供的接入文档为准,有其他场景需联系数美服务协助开通。
可选值如下:
昵称:nickname
私聊:message
群聊:groupChat
标题:title
公告:notice
帖子:article
评论:comment
弹幕:barrage
搜索栏:search
房间名:roomName
个人简介:profile
商品名称:productName
商品介绍:productInfo
商品评价:productReviews
内部交流:internalChat
外部合作:outsideWork
typestringY检测风险类型
可选值如下:
识别所有风险类型:ALL
datajson_objectY请求的数据内容
最长1MB

其中,data的内容如下:

参数名称类型是否必选说明
textstringY要检测的文本内容
文本字数上限2000字200字内效果最佳
若传递nickname字段,则会同时校验文本+昵称内容。
注意:有超过2000字以上文本内容建议联系数美协商
tokenIdstringY建议使用贵司用户UID(可加密)自行生成 ,
标识用户唯一身份用作灌水和广告等行为维度风控。
如无用户uid的场景建议使用唯一的数据标识传值
nicknamestringN用户昵称
ipstringN发送该文本的的用户公网ipv4地址
该参数用于IP维度的用户行为分析,强烈要求传入
extrajson_objectN于辅助文本检测的相关信息,提升拦截效果
deviceIdstringN数美设备指纹标识

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

参数名称类型是否必选说明
receiveTokenIdstringN接收者账号:强烈建议当eventId值为message时,传入接收者的tokenId。
用于联系上下文辅助拦截分段式发送内容
topicstringN话题编号:强烈建议当eventId值为article时,传入帖子Id(书评区编号、论坛帖子编号等)
用于联系上下文辅助拦截分段式发送内容
roomstringN房间编号:
强烈建议当eventId值为groupChat时,传入房间Id
用于联系上下文辅助拦截分段式发送内容
atIdstringN被@用户的tokenId:强烈建议当eventId值为groupChat时,传入被@用户的tokenId
防止公开场景相互@导致的误伤
levelintN用户等级:针对不同等级的用户可配置不同拦截策略
可选值:
0:最低级用户,典型如新注册、完全不活跃的用户等;
1:较低级用户,典型如低活跃或低等级用户;
2:中等级用户,典型如具备一定活跃或等级中等用户;
3:较高级用户,典型如高活跃或高等级用户;
4:最高级用户,典型如付费用户、VIP用户
rolestringN用户角色
对不同角色可配置不同策略。
直播领域可取值:
房管:ADMIN
主播:HOST
系统角色:SYSTEM
游戏领域可取值:
管理员:ADMIN
普通用户:USER
sexintN用户性别,可选值:
0:男性
1:女性
2:性别不明
isTokenSeparateintN区分不同appId下的相同应用,可选值:
0:不区分
1:区分
不传该字段默认值为0

请求示例#

{
"accessKey":"*************",
"appId":"default",
"eventId":"message",
"type":"ALL",
"data":
{
"text":"+v12345qwer",
"tokenId":"username",
"ip":"118.89.214.89",
"deviceId":"*************",
"nickname":"***********",
"extra":
{
"topic":"12345",
"atId":"username1",
"room":"ceshi123",
"receiveTokenId":"username2",
"level":1,
"role":"ADMIN",
"isTokenSeparate":0
}
}
}