同步接口#
请求参数#
请求URL：#
| 集群 | URL |
|---|---|
| 北京 | http://api-article-bj.fengkongcloud.com/webpage/v4 |
| 弗吉尼亚 | http://api-article-fjny.fengkongcloud.com/webpage/v4 |
| 新加坡 | http://api-article-xjp.fengkongcloud.com/webpage/v4 |
字符编码格式：#
UTF-8字符集编码
请求方法：#
POST
建议超时时长：#
15s
请求参数：#
放在HTTP Body中，采用Json格式，Body大小不可超过3.5M，具体参数如下：
| 请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
|---|---|---|---|---|
| accessKey | string | 接口认证密钥 | Y | 由数美提供 |
| imgType | string | 网页中的图片识别类型 | Y | 可选值： POLITY：涉政识别 EROTIC：色情&性感违规识别 VIOLENT：暴恐&违禁识别 QRCODE：二维码识别 ADVERT：广告识别 IMGTEXTRISK：图片文字违规识别（如需要识别图片里文字的违规内容，务必传入图片文字违规识别功能） BOCR：OCR小语种识别支持和语种自动检测（仅限新加坡集群） NONE：不审核图片 以上type除NONE以外都可以下划线组合，如POLITY_QRCODE_ADVERT用于涉政、二维码和广告组合识别 |
| txtType | string | 网页中的文字识别类型 | Y | 可选值： POLITY：涉政检测 VIOLENT：暴恐检测 BAN：违禁检测 EROTIC：色情检测 DIRTY：辱骂检测 ADVERT：广告检测 PRIVACY：隐私检测 ADLAW：广告法检测 MEANINGLESS：无意义检测 FRUAD：网络诈骗检测 UNPOACH：高价值用户防挖检测 TEXTMINOR:未成年人内容检测 TEXTRISK：常规风险检测（包含：涉政、暴恐、违禁、色情、辱骂、广告、隐私、广告法、无意义） NONE：不审核文本 以上type除NONE以外都可以下划线组合，如：TEXTRISK_FRUAD；type间组合取并集，如：TEXTRISK_POLITY按照常规风险检测处理 |
| appId | string | 应用标识 | Y | 用于区分应用，需要联系数美服务开通，请使用数美单独提供的传值为准 |
| eventId | string | 事件标识 | Y | 需要联系数美服务开通，请使用数美单独提供的传值为准 |
| callback | string | 回调http接口 | N | 当该字段非空时，服务将根据该字段回调通知用户审核结果 |
| acceptLang | string | 返回标签的语种类型 | N | 选择返回标签的语种类型 可选值： zh：中文 en：英文 不传入默认为返回中文标签 |
| articleDoubleJumpConfig | json_object | 是否开启网页二跳审核方式 | N | 详见articleDoubleJumpConfig参数 |
| articleScreenShotConfig | json_object | 是否开启网页截屏审核方式 | N | 详见articleScreenShotConfig参数 |
| data | json_object | 请求的数据内容 | Y | 最长1MB, 详见data参数 |
其中，data的内容如下：
| 请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
|---|---|---|---|---|
| url | string | 要检测的网页链接 | N | 网址链接可下载，其中网址头部的content-type需为text/html。 网址内容大小500m以内，文本长度限制50w字，图片张数限制500张。（url、text、contents传且只能传其中一个） |
| text | string | 要检测的网页文本 | N | 纯文本内容审核，文本长度限制50w字。（url、text、contents传且只能传其中一个） |
| contents | string | 要检测的网页源码 | N | 网址源码审核，文本长度限制50w字，图片张数限制500张。（url、text、contents传且只能传其中一个） |
| nickname | string | 用户昵称 | N | 校验昵称内容风险 |
| ip | string | ip地址 | N | 发送该文本的的用户公网ipv4或ipv6地址 |
| tokenId | string | 用户账号标识，建议使用贵司用户UID（可加密）自行生成，标识用户唯一身份用作灌水和广告等行为维度风控。 如无用户uid的场景建议使用唯一的数据标识传值 | Y | 由数字、字母、下划线、短杠组成的长度小于等于64位的字符串 |
| lang | string | 待检测的文本内容语种 | N | 可选值和对应语种如下：zh：中文en：英文ar：阿拉伯语hi：印地语es：西班牙语fr：法语ru：俄语pt：葡萄牙语id：印尼语de：德语ja：日语tr：土耳其语vi：越南语it：意大利语th：泰语tl：菲律宾语ko：韩语ms：马来语auto：自动识别语种类型默认值zh，国内集群客户可不传或zh；海外文本内容如果不能区分语种建议取值auto，系统会自动检测语种类型 |
| receiveTokenId | string | 私聊场景下消息接收者的tokenId | N | 由数字、字母、下划线、短杠组成的字符串 |
| returnAllImg | int | 返回图片的等级 | N | 选择返回图片的等级：0：返回风险等级为非pass的图片；1：返回所有风险等级的图片。默认为0 |
| returnAllText | int | 返回文本的等级 | N | 选择返回文本的等级：0：返回风险等级为非pass的文本；1：返回所有风险等级的文本。默认为0 |
| level | int | 用户等级，针对不同等级的用户可配置不同拦截策略 | N | 可选值：0：最低级用户，典型如新注册、完全不活跃或等级为0的用户等;1：较低级用户，典型如低活跃或低等级用户等；2：中等级用户，典型如具备一定活跃或等级中等的用户等；3：较高级用户，典型如高活跃或高等级用户等；4：最高级用户，典型如付费用户、VIP用户等 |
| gender | string | 用户性别 | N | 可选值： male男性 female女性 |
| deviceId | string | 数美设备标识 | N | 数美设备指纹生成的设备唯一标识 |
| dataId | string | 数据标识 | N | 数据标识 |
| extra | json_object | 辅助参数 | N | 用于辅助文本检测的相关信息，详见extra参数 |
其中，data 下 extra数组每个元素的内容如下：
| 请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
|---|---|---|---|---|
| room | string | 直播间/游戏房间编号 | N | 传入的是直播间、聊天室等数据（eventId值为groupChat）时，开启上下文识别功能，建议传入，否则不能关联上下文 |
| passThrough | Json | 透传字段 | N | 该字段内容会随着返回值一起返回 |
其中，articleDoubleJumpConfig的内容如下：
| 请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
|---|---|---|---|---|
| isOpen | bool | 是否开启网页二跳审核 | N | 默认不开启 |
其中，articleScreenShotConfig的内容如下：
| 请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
|---|---|---|---|---|
| isOpen | bool | 是否开启网页截图审核 | N | 默认不开启 |
| width | int | 截图的宽度 | N | 默认截图宽度1080 |
| height | int | 截图的高度 | N | 默认截图高度6480 |
返回结果#
同步模式#
放在HTTP Body中，采用Json格式，具体参数如下：
| 参数名称 | 类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| code | int | 返回码 | Y | 1100：成功1901：QPS超限1902：参数不合法1903：服务失败9101：无权限操作 |
| message | string | 返回码描述 | Y | 和code对应： 成功 QPS超限 参数不合法 服务失败 无权限操作 |
| requestId | string | 请求标识 | Y | 本次请求数据的唯一标识,用于问题排查和效果优化，强烈建议保存 |
| riskLevel | string | 处置建议 | N | 可能返回值：PASS：正常，建议直接放行REVIEW：可疑，建议人工审核REJECT：违规，建议直接拦截 |
| textDetail | json_array | 风险详情 | N | 详见textDetail参数 |
| imgDetail | json_array | 风险详情 | N | 详见imgDetail参数 |
| auxInfo | json_object | 辅助信息 | Y | 详见auxInfo参数 |
| doubleJumpDetails | json_array | 透传字段 | N | 透传参数，原样返回 |
其中，textDetail的内容如下：
| 请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
|---|---|---|---|---|
| riskLabel1 | string | 一级风险标签 | Y | 一级风险标签，当riskLevel为PASS时返回normal |
| riskLabel2 | string | 二级风险标签 | Y | 二级风险标签，当riskLevel为PASS时为空 |
| riskLabel3 | string | 三级风险标签 | Y | 三级风险标签，当riskLevel为PASS时为空 |
| riskDescription | string | 风险原因 | Y | 当riskLevel为PASS时为"正常" |
| riskDetail | json_object | 风险详情 | Y | 风险详情，详见riskDetail参数 |
| allLabels | json_array | 辅助信息 | Y | 命中的所有风险标签以及详情信息。详见allLabels参数 |
| tokenProfileLabels | json_array | 辅助信息 | N | 属性账号类标签。详见账号标签参数 |
| tokenRiskLabels | json_array | 辅助信息 | N | 风险账号类标签。详见账号标签参数 |
其中，textDetail的riskDetail的内容如下：
| 参数名称 | 类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| matchedLists | json_array | 辅助信息 | N | 命中的客户自定义名单列表。详见matchedLists参数 |
| riskSegments | json_array | 辅助信息，高风险内容片段检测文本包含涉政、暴恐、违禁、广告法等风险内容的时候存在 | N | 详见riskSegments参数 |
其中，textDetail的riskDetail下matchedLists数组每个元素的内容如下：
| 参数名称 | 类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| name | string | 辅助信息 | N | 命中的名单名称 |
| words | json_array | 辅助信息 | N | 命中的敏感词数组。详见words参数 |
其中，matchedLists中，words数组每个元素的内容如下：
| 参数名称 | 类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| word | string | 辅助信息 | N | 命中的敏感词 |
| position | int_array | 辅助信息 | N | 敏感词所在位置 |
其中，textDetail的riskDetail下riskSegments的内容如下：
| 参数名称 | 类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| segment | string | 辅助信息 | N | 高风险内容片段 |
| position | int_array | 辅助信息 | N | 高风险内容片段所在位置 |
其中，imgDetail的内容如下：
| 请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
|---|---|---|---|---|
| riskLabel1 | string | 一级风险标签 | Y | 一级风险标签，当riskLevel为PASS时返回normal |
| riskLabel2 | string | 二级风险标签 | Y | 二级风险标签，当riskLevel为PASS时为空 |
| riskLabel3 | string | 三级风险标签 | Y | 三级风险标签，当riskLevel为PASS时为空 |
| riskDescription | string | 风险原因 | Y | 当riskLevel为PASS时为"正常" |
| riskDetail | json_object | 风险详情 | Y | 风险详情，详见riskDetail参数 |
| allLabels | json_array | 辅助信息 | Y | 命中的所有风险标签以及详情信息。详见allLabels参数 |
| tokenProfileLabels | json_array | 辅助信息 | N | 属性账号类标签。详见账号标签参数 |
| tokenRiskLabels | json_array | 辅助信息 | N | 风险账号类标签。详见账号标签参数 |
其中，imgDetail的riskDetail结构如下：
| 返回结果参数名 | 参数类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| faces | json_array | 返回图片中涉政人物的名称及位置信息 | N | |
| face_num | int | 人脸数量 | N | |
| persons | json_array | 仅当命中人像-多人时，数组元素会有多个，最多10个 | N | |
| person_num | int | 人像数量 | N | 有且仅有人像-多人下返回 |
| objects | json_array | 返回图片中物品或标志二维码的位置信息 | N | 数组仅会有一个元素 |
| ocrText | json_object | 返回图片中违规文字相关信息，当请求参数type字段包含IMGTEXTRISK和ADVERT时存在 | N | |
| riskSource | int | 标识资源哪里违规 | Y | 标识风险结果的来源1000：无风险1001：文字风险1002：视觉图片风险 |
其中，imgDetail的riskDetail下faces数组每个元素的内容如下：
| 返回结果参数名 | 参数类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| id | string | 人物编号 | N | 图片同一个位置下的人在不同标签下的编号相同。 如果同一个人在图片中出现n次，分配n个ID |
| name | string | 人物名称 | N | 能识别的公众人物名称 |
| location | int_array | 人物位置信息，该数组有四个值，分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标 | N | |
| face_ratio | float | 人脸占比 | N | |
| probability | float | 置信度，可选值在0～1之间，值越大，可信度越高 | N | 0～1之间的浮点数 |
其中，imgDetail的riskDetail下objects数组每个元素的内容如下：
| 返回结果参数名 | 参数类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| id | string | 编号，保证同一个位置下的物品在不同标签下的编号相同 | N | |
| name | string | 标识名称 | N | |
| location | int_array | 标识位置信息，该数组有四个值，分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567] 207代表的是左上角的x坐标 522代表左上角的y坐标 340代表的是右下角的x坐标 567代表的是右下角的y坐标 | N | |
| probability | float | 置信度，可选值在0～1之间，值越大，可信度越高 | N | 0～1之间的浮点数 |
| qrContent | string | 二维码的url信息 | N | 仅当命中二维码相关标签时返回 |
其中，imgDetail的riskDetail下persons数组每个元素的内容如下：
| 返回结果参数名 | 参数类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| id | string | 编号，保证同一个人在不同标签下的编号相同。如果同一个人在图片中出现n次，分配n个ID | N | |
| person_ratio | string | 人像在图中的占比 | N | |
| location | int_array | 人像位置坐标 | N | |
| probability | float | 置信度，可选值在0～1之间，值越大，可信度越高 | N | 0～1之间的浮点数 |
其中，imgDetail的riskDetail下ocrText的内容如下：
| 返回结果参数名 | 参数类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| text | string | 识别出的文字 | Y | |
| matchedLists | json_array | 命中的客户自定义名单列表 | N | |
| riskSegments | json_array | 高风险片段内容，检测图片包含涉政、暴恐、违禁、广告法等风险内容的时候存在 | N |
其中，ocrText的matchedLists数组每个元素的内容如下：
| 返回结果参数名 | 参数类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| name | string | 命中的名单名称 | N | |
| words | json_array | 命中的敏感词信息 | N |
其中，matchedLists的words数组每个元素的内容如下：
| 返回结果参数名 | 参数类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| word | string | 命中的敏感词 | N | |
| position | int_array | 敏感词所在位置 | N |
其中，ocrText的riskSegments的每个元素的详细内容如下：
| 返回结果参数名 | 参数类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| segment | string | 高风险内容片段 | N | |
| position | int_array | 高风险内容片段所在位置 | N |
其中，allLabels的内容如下：
| 参数名称 | 类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| riskLabel1 | string | allLabels不为空时必返 | Y | 一级风险标签 |
| riskLabel2 | string | allLabels不为空时必返 | Y | 二级风险标签 |
| riskLabel3 | string | allLabels不为空时必返 | Y | 三级风险标签 |
| riskDescription | string | allLabels不为空时必返 | Y | 风险原因 |
| probability | float | 置信度 | Y | 可选值在0～1之间，值越大，可信度越高 注意：allLabels不为空时必返 |
| riskDetail | json_object | 风险详情 | Y | 格式与上层riskDetail结构相同 注意：allLabels不为空时必返 |
| riskLevel | string | 风险等级 | Y | 可能返回值：REVIEW：可疑REJECT：违规 |
其中，tokenProfileLabels、tokenRiskLabels的内容如下：
| 参数名称 | 类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| label1 | string | 一级标签 | N | |
| label2 | string | 二级标签 | N | |
| label3 | string | 三级标签 | N | |
| description | string | 标签描述 | N | |
| timestamp | Int | 打标签时间戳 | N | 13位Unix时间戳，单位：毫秒 |
其中，doubleJumpDetails的内容如下：
| 请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
|---|---|---|---|---|
| url | string | 二跳链接 | Y | 本段结果对应的网址链接 |
| riskLevel | string | 处置建议 | N | 可能返回值：PASS：正常，建议直接放行REVIEW：可疑，建议人工审核REJECT：违规，建议直接拦截 |
| textDetail | json_array | 风险详情 | N | 详见detail参数 |
| imgDetail | json_array | 风险详情 | N | 详见detail参数 |
其中，auxInfo的内容如下：
| 请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
|---|---|---|---|---|
| textNum | int | 当前请求中的字符数，与计费数目一致 | Y | 当前请求中的字符数，其中字符数包括汉字，英文，标点符号，空格等 |
| imgNum | int | 当前请求中的图片数，与计费数目一致 | Y | 当前请求中的图片数，如遇动图会截取3帧；如遇长图会进行切分 |
回调模式#
如果在请求参数中指定了 callback，系统会自动推送机审结果至指定URL
请求返回参数：#
| 参数名称 | 类型 | 参数说明 | 是否必返 | 规范 |
|---|---|---|---|---|
| code | int | 返回码 | Y | 1100：成功1901：QPS超限1902：参数不合法1903：服务失败9100：余额不足9101：无权限操作 |
| message | string | 返回码描述 | Y | 和code对应： 成功 QPS超限 参数不合法 服务失败 余额不足 无权限操作 |
| requestId | string | 请求标识 | Y | 本次请求数据的唯一标识,用于问题排查和效果优化，强烈建议保存 |
回调返回参数：#
回调返回结构同同步请求响应；返回HTTP状态码为200时，表示推送成功；否则系统将进行最多8次推送。
