文档解决方案提交接口用于文档的提交，易盾会自动解析文档中的文本和图片，检测并过滤文件中的有害信息，保障文件内容安全。

接口说明

该接口为文档解决方案文档提交接口，支持 HTTP 协议接口调用。结果异步返回；

鉴权说明

易盾内容安全服务使用签名方法对接口进行鉴权，所有接口每一次请求都需要包含签名信息（signature 参数），以验证用户身份，防止信息被恶意篡改。目前支持 MD5，SHA1，SHA256，SM3 几种加密算法，详细信息，请参见接口鉴权

检测数据要求

请求体限制：所有请求参数大小总和不能超过10M

文档要求

• 文档支持类型：URL 和 内容传入
• 文档支持格式：
  （1）文档格式：txt、doc、docx、ppt、pptx、xls、xlsx、xlsm、pdf、rar、zip、csv、rtf、odt、ofd、lrc、pot、potx、 pps、 ppsx、 pptm、 potm、 ppsm、 dot、 dotx、docm、dotm、xltm、xltx、xlt、et、ett、wps、wpt、dps、dpt、dwg、pst、vsd、vsdx、vsdm、xml、epub、Markdown、sb3
  （2）压缩包内音视频格式：wav、mp3、aac、amr、m4a、wma、ogg、ape、flac、alac、flv、mkv、mp4、rmbv、avi、wmv、3gp、ts、mov、rm、mpeg、wmf、m3u8
• 文档大小：URL 方式传入，单文档<300M，没有内容字符限制；内容方式传入，内容字符<100000 ；如果传 zip，压缩包内容文档个数不能超过200

检测耗时

文档解决方案检测结果仅支持异步返回，具体超时时间建议设置为200ms

历史版本

v1版本文档解决方案提交接口请点此查看

请求

名称	值
HTTP URL	http://as-file.dun.163.com/v2/file/submit
HTTP Method	POST

请求头

名称	类型	描述
Content-Type	String	固定值："application/x-www-form-urlencoded"

请求参数

请求参数由公共参数和业务参数两部分组成

公共参数

公共参数包含密钥信息和参数签名信息，公共参数详细见请求公共参数

业务参数（URL方式）

名称	类型	是否必填	最大长度	描述
version	String	Y	4	接口版本号，可选值v2.0
ip	String	N	128	用户IP地址，建议抄送，辅助机审策略精准调优
publishTime	Number	N	13	发表时间，UNIX 时间戳（毫秒值）
dataId	String	Y	128	上传数据唯一标识，能够根据该值定位到该条数据，如对数据结果有异议，可以发送该值给策略经理查询
account	String	N	128	用户唯一标识，如果无需登录则为空
url	String	Y	1024	文档下载的URL, 支持文档大小上限为300M
fileName	String	N	512	文档标题，默认不过检，如需检测请联系您的专属策略经理
checkFlag	Number	N	4	1：仅检测文本， 2：仅检测图片 ，4：检测文本+文本中图片url ，7：检测文本+图片，8：检测音视频，15：检测文本+图片+音视频 默认值为7
callback	String	N	512	数据回调参数，调用方根据业务情况自行设计，当调用举报解决方案异步接口获取结果时，该接口会原样返回该字段。作为数据处理标识，因此该字段应该设计为能唯一定位到该次请求的数据结构，如对用户的昵称进行检测，dataId可设为用户标识（用户ID），用户修改多次，每次请求数据的dataId可能一致，但是callback参数可以设计成定位该次请求的数据结构，比如callback字段设计成json，包含dataId和请求的时间戳等信息，当然如果不想做区分，也可以直接把callback设置成dataId的值。
callbackUrl	String	N	1024	异步结果回调通知到客户的URL。主动回调数据接口超时时间设置为2s，为了保证顺利接收数据，需保证接收接口性能稳定并且保证幂等性。

业务参数（内容传入方式）

名称	类型	是否必填	最大长度	描述
version	String	Y	4	接口版本号，可选值v2.0
ip	String	N	128	用户IP地址，建议抄送，辅助机审策略精准调优
publishTime	Number	N	13	发表时间，UNIX 时间戳（毫秒值）
dataId	String	Y	128	上传数据唯一标识，能够根据该值定位到该条数据，如对数据结果有异议，可以发送该值给策略经理查询
account	String	N	128	用户唯一标识，如果无需登录则为空
content	String	Y	100000	文档的内容。不能和url同时为空，也不能和url同时有值
fileName	String	N	512	文档标题，默认不过检，如需检测请联系您的专属策略经理
checkFlag	Number	N	4	1：仅检测文本， 2：仅检测图片 ，4：检测文本+文本中图片url， 7：检测文本+图片，8：检测音视频，15：检测文本+图片+音视频，默认值为7
callback	String	N	512	数据回调参数，调用方根据业务情况自行设计，当调用举报解决方案异步接口获取结果时，该接口会原样返回该字段。作为数据处理标识，因此该字段应该设计为能唯一定位到该次请求的数据结构，如对用户的昵称进行检测，dataId可设为用户标识（用户ID），用户修改多次，每次请求数据的dataId可能一致，但是callback参数可以设计成定位该次请求的数据结构，比如callback字段设计成json，包含dataId和请求的时间戳等信息，当然如果不想做区分，也可以直接把callback设置成dataId的值。
callbackUrl	String	N	1024	异步结果回调通知到客户的URL。主动回调数据接口超时时间设置为2s，为了保证顺利接收数据，需保证接收接口性能稳定并且保证幂等性。

请求体示例

URL方式

url=https://file/111.txt&version=v2.0&signature=xxx&secretId=xxx&timestamp=1670842849000&nonce=23456&dataId=12345

内容传入方式

content=ssssd&version=v2.0&signature=xxx&secretId=xxx&timestamp=1670842849000&nonce=12345&dataId=12345

响应

响应结果

响应公共字段已省略，详细见响应公共字段

结果异步返回

默认情况下是异步返回结果

名称	类型	是否返回	描述
result	Object[]	是	文档异步提交检测结果
∟ taskId	String	是	本次请求数据标识，可以根据该标识查询数据最新结果
∟ dataId	String	否	上传数据唯一标识，能够根据该值定位到该条数据，如对数据结果有异议，可以发送该值给策略经理查询
∟ callback	String	否	数据回调参数,请求参数中传来的callback字段原样返回

响应示例

结果异步返回示例

{
    "code":200,
    "msg":"ok",
    "result":{
        "dataId":"131246",
        "callback":"i am callback",
        "taskId":"jk5wux0l0u6zjmotwc088svg05009pgr"
    }
}

响应返回码

响应返回码见：响应返回码

示例代码

服务端 SDK 接入

推荐使用我们提供的服务端 SDK 进行接入（目前支持 Java 和 Go 两种语言），不但可以节省接入成本，实现更快速的集成，并享有灵活的请求配置选项，同时 SDK 内置了错误重试、熔断降级等功能，提升服务可用性。点击 服务端 SDK 接入指引 了解更多。

Github Demo 地址

• Java SDK Demo
• Golang SDK Demo

Gitee Demo 地址（Github 无法访问时选择）

• Java SDK Demo
• Golang SDK Demo

HTTP API 接入

Github Demo 地址

• PHP Demo
• Python Demo
• Golang Demo
• Node.js Demo
• C# Demo
• Java Demo

Gitee Demo 地址（Github 无法访问时选择）

• PHP Demo
• Python Demo
• Golang Demo
• Node.js Demo
• C# Demo
• Java Demo