1. 接口文档
石墨文档中台(SDK)
CO-1.4
  • >=CO-1.6
  • CO-1.5
  • CO-1.4
  • CO-1.2-1.3
  • <CO-1.2
  • 一文认识石墨文档中台
  • 文档中台支持的格式
  • 10 分钟创建协同文档
  • 10分钟创建预览文档
  • 示例代码仓库
  • 更新日志
  • 典型场景案例
    • 云盘场景
    • IM场景
  • 接口文档
    • 接口文档概览
    • 错误码说明
    • 石墨后端API
      • 请求签名凭证
        • 签名凭证类型
        • 签名凭证-Signature
        • 签名凭证-Token
      • 系统管理
        • 应用管理
          • 获取应用详情
          • 更新应用回调地址
        • 用户席位管理
          • 用户席位状态说明
          • 获取用户列表和席位状态
          • 激活用户席位​
          • 取消用户席位​
          • 批量设置用户席位
      • 协同文档创建删除
        • 访问协同文档
        • 创建协同文档
        • 创建协同文档副本
        • 删除协同文档
      • 预览文件
        • 访问预览文件
        • 创建文件预览缓存
      • 文档导入导出
        • 文档导入
          • 文档导入说明
          • 创建导入任务
          • 获取导入进度
          • 创建导入任务(旧版)
          • 获取导入进度(旧版)
        • 文档导出
          • 文档导出流程
          • 创建导出任务
          • 获取导出进度
      • 文档操作
        • 专业表格(Excel)
          • 专业表格接口参数说明
          • 获取表格内容
          • 获取表格中的评论数
          • 更新表格内容
          • 追加表格内容
          • 删除表格行
          • 新增表格工作表
        • 轻文档(Markdown)
          • 获取文档中的评论列表
        • 通用
          • 获取文件纯文本内容
          • 文件纯文本字数统计
          • 获取历史列表
          • 获取版本列表
          • 获取文档内容中所有的at人信息列表
        • 传统文档(Word)
          • 传统文档书签说明
          • 读取传统文档书签内容
          • 替换传统文档书签内容
    • 石墨前端API
      • 【前端】JS-API
      • 编辑器API
        • 表单
        • 应用表格
        • 表格
        • 轻文档
        • 幻灯片
        • 传统文档
    • 回调接口(接入方需实现)
      • 【后端】回调接口说明
      • 【后端】回调总览
      • 文件信息
        • 获取文件元信息-协同文档
        • 获取文件元信息-预览文档
        • 获取当前用户的文件列表
        • 获取文件的协作者列表
        • 获取接入方指定文件的完整访问地址
        • 获取文件元信息-协同文档自动任务(admin)
        • 根据指定用户获取文件元信息-协同文档(admin)
      • 用户信息
        • 批量获取用户信息(admin)
        • 获取当前用户信息
        • 获取当前用户所在团队信息
        • 获取指定用户信息
        • 获取用户水印信息
        • 获取用户部门路径
        • 批量获取用户信息
      • 团队和部门
        • 获取团队下的成员列表
        • 获取部门信息
        • 获取部门的下级部门节点
        • 获取部门下的成员分页列表
      • 搜索功能
        • 获取与文件相关的用户列表
        • 获取与文件相关的文件列表
        • 按关键字搜索文件和用户列表
      • 消息推送
        • 评论(Comment)
          • 轻文档
            • 添加评论
            • 删除评论
            • 结束评论
            • 对于评论的回复评论
          • 表格
            • 添加评论
            • 删除评论
            • 结束评论
            • 对于评论的回复评论
          • 传统文档
            • 添加评论
            • 更新评论
            • 删除评论
            • 对于评论的回复评论
          • 幻灯片
            • 添加评论
            • 删除评论
            • 结束评论
            • 对于评论的回复评论
          • 应用表格
            • 添加评论
            • 对于评论的回复评论
            • 删除评论
        • 讨论(Discussion)
          • 轻文档
            • 发送讨论消息
        • 提及(MentionAt @ 人)
          • 轻文档
            • 在评论中 at
            • 在讨论中 at
            • 在正文中 at
          • 表格
            • 在评论中 at
            • 在正文中 at
          • 传统文档
            • 在评论中 at
            • 在正文中 at
          • 应用表格
            • 在评论中 at
            • 在正文中 at
        • 日期提醒 (DateMention)
          • 轻文档
            • 创建
            • 修改
            • 删除
          • 表格
            • 创建
            • 修改
            • 删除
          • 传统文档
            • 创建
            • 修改
            • 删除
        • 文件内容更新 (FileContent)
          • 文件内容更新
        • 文档协作者协同状态变化 (Collaborator)
          • 文档协作者协同状态变化
        • 版本 (Revision)
          • 版本
        • 系统事件 (System)
          • 系统事件
        • (实验性) 回调请求错误
          • 回调请求错误
  • 常见问题
    • 复制粘贴、全屏操作不正常
    • 如何实现文档模板功能
    • 文档内容何时保存
    • 移动端不支持blob协议导致预览失败
    • 如何实现文件重命名
    • @人员时如何直接跳转至对应锚点
    • 访问接口提示 signature 无效怎么办
    • 文件预览或导入报错如何处理
    • 首次接入 SDK 报错 应该排查哪些接口
    • 文档预览如何做防盗链
    • 如何通过接口修改文档内容
  1. 接口文档

错误码说明

石墨文档中台定义了一系列错误码,用于处理对接或使用过程中出现的问题。不同错误码的定义和解决方法不同,希望能够帮助您快速定位并解决问题。

接入方对接错误码#

错误码错误码说明解决方案
10001不合法的 endpoint 地址确认 App 的 endpoint 回调地址前缀是否设置正确,使用更新应用信息接口更新 endpointUrl 字段
10002获取指定文件信息 404检查接入方文件信息接口实现
10003获取当前用户信息 404检查接入方当前用户接口实现
10004获取指定用户信息 404检查接入方指定用户信息接口实现
10005获取用户信息列表 404检查接入方用户列表信息接口实现
10006获取协作权限用户列表 404检查接入方协作权限用户列表接口实现
10007搜索最近联系人列表 404检查接入方获取最近用户接口实现
10008搜索最近使用文件列表 404检查接入方获取最近使用文件接口实现
10009接入方回调接口出现 HTTP 错误,状态码 >= 400检查接入方对应接口
10010无效的正常 http 状态码,仅识别 200检查接入方接口实现,目前认为 200 状态码为正常返回
10011不是合法的 JSON 数据检查接入方是否按照文档描述的 JSON 格式数据、数据的字段结构、数据字段类型正确返回数据
10012File 数据不符合预期文件信息不符合预期,检查接入方文件信息接口
10013FileType 数据不符合预期获取文件类型接口返回不符合预期,检查接入方实现是否与文档说明一致
10014User 数据不符合预期用户信息接口不符合预期,请检查接入方实现接口是否与相关文档说明一致
10015请求接入方回调接口时发生网络错误向通过 endpointUrl 组装的接入方回调接口发起请求时遇到网络错误,石墨 SDK 集群环境是否无法正常连接至 endpointUrl 域名 或 IP 指向的接入方回调地址,如无法访问公网、网络配置等因素

应用接口错误码#

错误码错误码说明解决方案
20001创建应用参数错误根据提示检查参数
20002创建应用失败如果偶现可忽略,重复出现请联系石墨人员
20003更新应用参数错误根据提示检查参数
20004更新应用失败如果偶现可忽略,重复出现请联系石墨人员
20005应用不存在检查url参数应用id

账号接口错误码#

错误码错误码说明解决方案
30001创建接入账号参数错误根据提示检查参数
30002创建接入账号失败如果偶现可忽略,重复出现请联系石墨人员
30003登录参数错误根据提示检查参数
30004登录验证失败如果偶现可忽略,重复出现请联系石墨人员
30005生成 Token 失败如果偶现可忽略,重复出现请联系石墨人员
30006账号密码不匹配请检查账号、密码是否输入正确
30007修改密码参数错误根据提示检查参数
30008修改密码失败如果偶现可忽略,重复出现请联系石墨人员

协同文档错误码#

错误码错误码说明解决方案
70001创建文件参数错误根据提示检查参数
70003初始化文件内容失败如果偶现可忽略,重复出现请联系石墨人员
70004创建文件信息失败如果偶现可忽略,重复出现请联系石墨人员
70005创建文件历史失败如果偶现可忽略,重复出现请联系石墨人员
70006协同文档内容初始化失败或未初始化检查是否为以下情况:1. 创建协同文档失败时,未处理错误直接使用文件 ID 打开文档。需要处理错误 2. 未等待导入任务结束,直接使用文件 ID 打开文档。需要获取进度直到成功或失败 3. 接入方提供的对象存储服务不可用
70007初始化协同文档内容异常出现请联系石墨人员
70008无法识别的文件类型请检查文件类型
70012文件 ID 对应的文件已存在请检查文件 ID
70013文件不存在请确认是否在 创建协同文档 成功后 或 导入文件、获取导入进度 完成后,访问此协同文档。若遇到 创建失败(HTTP Status >= 400)或 导入错误 (导入文件 或 获取导入进度 失败) 时,做相应处理,不应在失败后打开此文件
70015源文件内容获取异常如果偶现可忽略,重复出现请联系石墨人员排查
70016目标文件已存在但未找到创建副本任务重复出现建议使用目标文件 ID 删除文件后重新创建副本
70017目标文件创建副本执行失败出现此错误时,石墨将删除目标文件关联记录
70018获取创建副本任务时报错如果偶现可忽略并重试,重复出现请联系石墨人员排查
70019创建副本任务正在进行中需重试后获取最新状态
70020未知的副本任务状态如果偶现可忽略并重试,重复出现请联系石墨人员排查
60010获取侧边栏历史信息参数错误根据提示检查参数
60011获取所有历史失败如果偶现可忽略,重复出现请联系石墨人员
60012历史内容错误如果偶现可忽略,重复出现请联系石墨人员
60014获取历史创建用户信息失败如果偶现可忽略,重复出现请联系石墨人员
100002获取版本列表失败如果偶现可忽略,重复出现请联系石墨人员
100003获取版本创建用户信息失败如果偶现可忽略,重复出现请联系石墨人员

文件预览错误码​#

错误码错误码说明解决方案
90028预览已经在创建中查看是否对同一文件同时多次创建预览
90031预览导入异常如果偶现可重试
90032预览导入失败检查文件格式是否正确
90033不支持预览的类型不支持预览的类型
90035预览文件下载失败检查文件元信息回调接口返回的下载链接是否正常
90040未知的错误错误详情参考返回的message字段,一般可重试成功
90042带密码的文件检查文件是否带密码
90043预览的图片格式不正确检查文件格式
90050, 90052文件过大请尝试将文件拆分之后再预览
90054预览生成超时如果偶现可重试

导入导出错误码​#

错误码错误码说明解决方案
120001导入参数错误根据提示检查参数
120002导入失败如果偶现可忽略,重复出现请联系石墨人员
120003导入权限错误请检查是否登录,以及当前账户对当前文件的权限
120004导入进度查询参数错误根据提示检查参数
120005导入进度查询失败如果偶现可忽略,重复出现请联系石墨人员
120006导出参数错误根据提示检查参数
120007导出失败如果偶现可忽略,重复出现请联系石墨人员
120008导出进度参数错误根据提示检查参数
120009导出进度查询失败如果偶现可忽略,重复出现请联系石墨人员
120010导入进度未找到请检查是否为该文件创建过导入任务
120011导入进度结果已超时导入任务已过期,请重新创建
120012导出的源文件类型不支持该类型的文档不支持导出,若有需求,请联系石墨人员
120013文件不支持导出为当前格式请导出为其他格式
120015文件已经导入请重新上传该文件,再进行导入
120016文件不支持导入请检查文件文件名称以及文件类型
120017导入任务没有创建请先创建导入任务
120018导入文件太大请尝试将文件拆分之后再导入
120019导入文件大小无效请检查导入文件是否为空
120020没有导出权限请检查是否有该文件的导出权限
120022导出任务没有创建,或者已经过期请重新创建导出任务
120023导出结果解析失败,或者已经过期请重新创建导出任务
120024导入结果解析失败,或者已经过期请重新创建导入任务
120401导入/导出内部处理异常请重新创建导入任务
120402导入内部处理异常请重新创建导入任务
120403导出内部处理异常请重新创建导出任务
120404加载失败,文档体积过大请尝试对文件瘦身或拆分后再试
120405处理失败,文档体积过大请尝试对文件瘦身或拆分后再试
120406文档内部处理异常重复出现请联系石墨人员
120502表格有密码保护请取消加密后再导入
120503表格解析后的数据大于 80M,超过平台限制。无法成功导入请尝试将表格拆分之后再导入
120504表格解析后有失效的内链接请删除内链接后再导入
120505表格过大导致解析失败请检查表格中有无冗余数据,请尝试删除冗余的空白行列后再导入
120506表格是 Strict Open XML 格式,不支持导入请另存为 Excel 工作簿(*.xlsx)格式后再导入
120507文件格式与扩展名无效,无法打开表格请检查您的文件
120508表格是 XLSB 格式,不支持导入请打开另存为 Excel 工作簿(.xlsx) 格式后再导入
120509表格单元格数量已超过 200 万个请尝试将表格拆分之后再导入
120510表格单元格总数量已超过 500 万个请尝试将表格拆分之后再导入
120511导入/导出异常请重新导入/导出
120512导入文件过大,数据解析异常请尝试将文件拆分之后再导入
120513已达 Excel 最大行限制,无法导出请删除多余空白行
120514文件过大或图片过多导致导出失败请拆分成多个表格后再一个个导出
120515sheet名称不能包含特殊字符请去掉名称中的 / \ ? * : ' ] [ 等字符后再导出
120516当前服务正忙请稍后再试
120517文档密码错误请重新输入
120518超过了导出图片格式的限制请导出为其他格式
120519后台处理中请稍后重试
120520表格过大,处理失败请尝试对文件瘦身或拆分表格后再试
120530表格公式计算超时请稍后重试
120534表格的函数计算量过大,处理失败请减少表格中函数的数量或拆分表格后重试
修改于 2026-04-01 10:20:07
上一页
接口文档概览
下一页
签名凭证类型
Built with