本文档由
石墨办公
提供。
石墨文档中台-开发文档
co1.8.20260830
co1.8.20260830
co1.8.20260630
全部文档
前端接口
后端接口
回调接口
全部文档
前端接口
后端接口
回调接口
co1.8.20260830
co1.8.20260830
co1.8.20260630
石墨官网
预约演示
co1.8.20260830
co1.8.20260830
co1.8.20260630
用户席位管理
复制页面
整体概述
错误码说明
文件-预览 API
访问预览文件
GET
创建文件预览缓存
POST
文件-协同编辑文件管理 API
访问协同编辑文件
创建协同文件(新版带额外参数)
POST
创建协同文件副本
POST
删除协同文件
DELETE
文件-导入导出 API
文件导入
文件导入说明
创建导入任务
获取导入进度
创建导入任务(旧版)
获取导入进度(旧版)
文件导出
文件导出流程
导出文件
获取导出进度
文件-文档文件(类 Markdown) API
获取文档中的评论列表
GET
文件-文稿文件(Word) API
文稿书签说明
读取文稿书签内容
GET
替换文稿书签内容
PUT
文件-表格文件(Excel) API
表格接口参数说明
获取表格内容
GET
获取表格中的评论数
GET
更新表格内容
POST
追加表格内容
PUT
删除表格行
DELETE
新增表格工作表
POST
文件-获取额外信息 API
获取文件的纯文本内容
文件纯文本字数统计
获取文件的历史列表
获取文件的版本列表
获取文件内容中所有的 @ 人信息列表
还原文件历史版本
系统管理 API
用户席位管理
用户席位状态说明
获取用户列表和席位状态
GET
激活用户席位
POST
取消用户席位
POST
批量设置用户席位
POST
其他 API
上报事件
创建行为历史
推送文件内全部的用户
推送用户全部的 websocket 连接
用户席位管理
复制页面
用户席位状态说明
用户席位
#
用户席位数代表可以同时使用石墨文档中台的人数(非同时在线人数)。
通常情况下,团队会出现人员变动,例如员工离职,此时为了离职员工不占用用户席位数,接入方可以使用用户席位相关接口来修改席位状态。
用户席位状态说明
#
值 域
席位状态
说明
1
激活
用户处于激活状态,占用席位数。
0
已禁用
用户已被禁用,不占用席位,必须重新激活才可以使用。
-1
未启用
用户被引用,但未实际使用文档系统,不占用席位数。
禁止重复激活
当月内同一用户仅允许激活一次
什么是"未启用"状态?
产生场景:
当您的系统集成了
@提及用户
功能时,可能会出现以下情况:
用户在@某人时,搜索到了石墨文档中台中尚未关联的用户
为了在编辑器的@下拉列表中显示这些用户,石墨文档中台会自动创建用户关联
此时这些用户的状态会被设置为"未启用"
重要特点:
不占用席位
:未启用状态的用户不会消耗您的席位配额
自动激活
:当用户首次执行实际操作时,会自动变为"激活"状态
自动激活触发条件:
当处于"未启用"状态的用户执行以下任一操作时,系统会自动将其激活为正式用户:
文件操作类
创建新文件
创建文件副本
进入编辑页面
内容处理类
导入文件
导出文件
预览文件
调用表格内容操作接口
信息获取类
获取文件历史记录
获取文件版本信息
获取文件纯文本内容
获取文件@人员列表
获取文件评论数据
注意事项:
自动激活时会尝试占用席位配额,如果席位不足,该用户将被拒绝访问。
修改于
2026-08-31 04:37:25
上一页
还原文件历史版本
下一页
获取用户列表和席位状态