跳到主要内容

文档内容查询

💡 调用API，需要认证。认证参考【接口认证】

API接口​

POST {apiPrefix}/content/query

提交文档内容查询任务

  • 任务添加失败，同步返回失败原因
  • 任务添加成功，同步返回任务ID。第三方可以配置任务回调通知获取任务状态。

请求体

Content-Type为application/json

参数名类型说明是否必须
fileUrlstring文件下载地址是
filenamestring包含后缀的文件名是
tokenTypestring三方token类型，值为cookie或者header否
tokenValuestring三方token值，zOffice下载文件或回调通知时回传否
callbackstring回调地址。任务结束后zOffice回调通知状态是
ops数组对文档内容查询的有序操作数组，数组对象见下方op说明。支持的操作列表见【查询列表](#查询列表)】是

请求体示例

{
    "fileUrl": "http://{{thirdparty-demo}}/v2/context/local-PublicAPI-contentUpdate-clearDoc/content",
    "filename": "demo-docx.docx",
    "tokenType":"cookie",
    "tokenValue":"zdocs_access_token={{zdocs_access_token}}",
    "callback": "http://{{thirdparty-demo}}/v2/context/convert/callback",
    "ops": [ {
        "actId": "QueryBookmarkRef",
        "options": {
            "names": ["书签一", "书签二"]
        }
    }]
    
}

正常返回：

{
    "taskId": "6f6598c8-c87e-420b-b6c4-6f1b187201dc",
    "code": "Ok",
    "detail": {
        "taskStatus": "IN_QUEUE"
    }
}

错误返回：

{
    "taskId": "695fbf6e-90d2-42ba-83d5-00e81e5e366e",
    "code": "TaskQueueCongestion",
    "detail": {
        "taskStatus": "FAIL"
    }
}

查询列表​

查询书签区域内容​

源文件类型支持doc/docx/wps 源文件最大300M

{
    "actId": "QueryBookmarkRef",
    "options": {
        "names": ["书签一", "书签二"]
    }
}

options说明

选项名选项类型是否必须说明
namesstring[]是包含书签名称的数组

下载结果：

{
	"书签一": "书签一区域内容",
	"书签二": "书签二区域内容"
}

说明：对于文档中不存在的书签，不会体现在结果中

查询文档限制编辑状态​

源文件类型支持doc/docx/wps 源文件最大300M

{
    "actId": "QueryRestrictEditing",
    "options": {}
}

下载结果：

{
    "enforcement": true,
    "edit": "READ_ONLY"
}
选项名选项类型是否必须说明
enforcement布尔值是是否开启限制编辑
edit布尔值否限制编辑类型，取值为 READ_ONLY | ALLOW_ONLY_REVISIONS | ALLOW_ONLY_COMMENTS | ALLOW_ONLY_FORM_FIELDS

查询文档修订记录数量​

源文件类型支持doc/docx/wps 源文件最大300M

{
    "actId": "QueryRevisionsCount",
}

下载结果：

{
    "revisionsCount": 1
}
选项名选项类型是否必须说明
revisionsCountint是修订记录数量

查询文档批注​

源文件类型支持doc/docx/wps/xls/xlsx 源文件最大300M，xlsx格式600M

{
    "actId": "QueryComments",
}

下载结果：

{
    "commentsCount": 2,
    "unresolvedCommentsCount": 1,
    "comments": [{
        "authorName": "作者",
        "creationTime": 1724055042162,
        "resolved": true,
        "content": "文本",
        "replies": [{...}] //回复批注
    }]
}
选项名选项类型是否必须说明
commentsCountint是批注数量
unresolvedCommentsCountint是未解决的批注数量
commentsarray是批注信息数组

备注：回复批注不会计入到数量中。

批注信息：

选项名选项类型是否必须说明
authorNamestring是作者名称
creationTimenumber是创建时间戳
resolvedboolean是是否解决
contentstring是批注内容
repliesarray否回复批注数组（字段同批注信息）

备注：回复批注的resolved属性没有意义，请关注主批注的resolved属性。

查询文档图片​

v8.2 开始支持

源文件类型支持doc/docx/wps 源文件最大300M

{
    "actId": "QueryImages",
    "options": {
        "imageIds": ["1", "3"]
    }
}

options说明

选项名选项类型是否必须说明
imageIdsstring[]是图片索引数组，索引从1开始，代表图片在文档中的位置。传入空数组时返回文档中所有图片

下载结果：

{
    "images": {
        "1": {
            "data": "iVBORw0KGgoAAAANSUhEUgAA...",
            "width": "100.5",
            "height": "75.0",
            "sizeBytes": 20480
        },
        "3": {
            "data": "/9j/4AAQSkZJRgABAQAAAQ...",
            "width": "200.0",
            "height": "150.0",
            "sizeBytes": 10240
        }
    }
}

返回字段说明

字段名类型说明
imagesobject图片结果对象，key为图片索引
datastring图片数据（base64编码）
widthstring图片宽度，单位pt
heightstring图片高度，单位pt
sizeBytesnumber图片大小，单位字节

说明：对于文档中不存在的图片索引，不会体现在结果中

最后于 更新