帮助中心

文档提交接口

2022.11.22 10:55:19

    接口地址

    http://as-file.dun.163.com/v1/file/submit

    接口描述

    智能解析文件中的文本和图片，检测并过滤文件中的有害信息，保障文件内容安全（支持过滤指定img标签中的图片url，请依照<img src="http://xxxxxx.jpg"/>规范提交）。建议您使用POST请求, 且仅接受 application/x-www-form-urlencoded 编码格式。

    请求参数

    公共参数已省略，详细见 请求公共参数，businessId可不传，其他参数如下：

    提交内容说明

    ◆ 文档URL传入：直接使用可下载文档URL传入（为加快文档检测速度，在已知文档格式的前提下，建议传入接口指定fileType），易盾自行进行下载解析；

    ◆ 文档内容传入：将自行解析后的文档内容通过content字段直接传入，更快得到检测结果；

    文档URL传入

    参数名称 类型 是否必选 最大长度 描述
    dataId String Y 128 数据唯一标识，能够根据该值定位到该条数据，如对数据结果有异议，可以发送该值给客户经理查询
    url String Y 512 文档下载的URL, 支持格式： txt、doc、docx、ppt、pptx、xls、xlsx、pdf、zip、ofd, 支持的文档大小上限为150M
    fileType Number N 4 若选择使用URL检测方式，建议指定文件格式，1：PDF, 2:DOC, 3:DOCX, 4:PPT, 5：PPTX, 6:XLS, 7:XLSX, 8:TXT, 9:ZIP(压缩包内文件不超过200), 11:OFD
    version String Y 4 接口版本v1.1为当前最新版本
    fileName String N 512 文档标题，默认不过检，如需检测请联系您的专属客户经理
    checkFlag Number N 4 1: 仅检测文本 2: 仅检测图片 3：检测文本+图片 7:检测文本+图片+img标签中的图片url,默认值为7
    dataType Number N 4 子数据类型，与易盾反垃圾云服务约定即可
    ip String N 128 用户IP地址
    account String N 128 用户唯一标识，如果无需登录则为空
    callback String N 512 数据回调参数，调用方根据业务情况自行设计，当调用文档解决方案离线接口获取结果时，该接口会原样返回该字段，详细见文档离线检测结果获取。作为数据处理标识，因此该字段应该设计为能唯一定位到该次请求的数据结构，如对用户的昵称进行检测，dataId可设为用户标识（用户ID），用户修改多次，每次请求数据的dataId可能一致，但是callback参数可以设计成定位该次请求的数据结构，比如callback字段设计成json，包含dataId和请求的时间戳等信息，当然如果不想做区分，也可以直接把callback设置成dataId的值。
    callbackUrl String N 1024 离线结果回调通知到客户的URL。主动回调数据接口超时时间设置为2s，为了保证顺利接收数据，需保证接收接口性能稳定并且保证幂等性。
    publishTime Number N 13 发表时间，UNIX 时间戳(毫秒值)

    文档内容传入

    参数名称 类型 是否必选 最大长度 描述
    dataId String Y 128 数据唯一标识，能够根据该值定位到该条数据，如对数据结果有异议，可以发送该值给客户经理查询
    content String Y 100000 文档的内容。不能和url同时为空，也不能和url同时有值
    version String Y 4 接口版本v1.1为当前最新版本
    fileName String N 128 文档标题，默认不过检，如需检测请联系您的专属客户经理
    checkFlag Number N 4 1: 仅检测文本 2: 仅检测图片 3：检测文本+图片 7:检测文本+图片+img标签中的图片url,默认值为7
    dataType Number N 4 子数据类型，与易盾反垃圾云服务约定即可
    ip String N 128 用户IP地址
    account String N 128 用户唯一标识，如果无需登录则为空
    callback String N 512 数据回调参数，调用方根据业务情况自行设计，当调用文本离线结果获取接口时，该接口会原样返回该字段，详细见文档离线检测结果获取。作为数据处理标识，因此该字段应该设计为能唯一定位到该次请求的数据结构，如对用户的昵称进行检测，dataId可设为用户标识（用户ID），用户修改多次，每次请求数据的dataId可能一致，但是callback参数可以设计成定位该次请求的数据结构，比如callback字段设计成json，包含dataId和请求的时间戳等信息，当然如果不想做区分，也可以直接把callback设置成dataId的值。
    callbackUrl String N 1024 离线结果回调通知到客户的URL。主动回调数据接口超时时间设置为2s，为了保证顺利接收数据，需保证接收接口性能稳定并且保证幂等性。
    publishTime Number N 13 发表时间，UNIX 时间戳(毫秒值)

    响应结果

    响应字段如下，响应通用字段已省略，详细见响应通用字段：

    result 数据结构

    参数名称 类型 描述
    taskId String 本次请求数据标识，可以根据该标识查询数据最新结果
    dataId String 数据唯一标识，能够根据该值定位到该条数据，如对数据结果有异议，可以发送该值给客户经理查询

    响应示例

    {
    "code": 200,
    "msg": "ok",
    "result": {
        "taskId": "079560a6c9f34783bdce47e168510038",
        "dataId": "ebfcad1c-dba1-490c-b4de-e784c2691768"
    }
}
    上一篇：签名生成算法 下一篇：文档离线结果获取
    对文档做个评价吧：

    如果遇到产品相关问题，您可 提交工单 或在线咨询寻求帮助。

    在线咨询 电话咨询：95163223 免费试用