用户席位管理
复制页面
石墨文档中台-开发文档
1. 适用范围
00. 概述
石墨文档中台能做什么?
三种典型的业务接入场景
石墨文档中台支持哪些格式?
01. 快速开始
基本概念
场景一:10 分钟创建预览文件
场景二:10 分钟创建协同编辑文件
02. 鉴权与安全
整体概述
签名凭证 Token
签名凭证 Signature
03. 文件预览
整体概述
如何预热预览缓存
如何防盗链
常见问题处理
04. 文件编辑
整体概述
协同文档权限设计
协同文件保存与更新机制
协同文件复制与删除
05. 文件导入导出
整体概述
常见问题处理
06. 石墨前端 API
整体概述
公共 API
公共处理方法
顶部栏定制 HeaderBars
编辑器 API
轻文档
传统文档
表格
幻灯片
表单
应用表格
07. 石墨后端 API
整体概述
错误码说明
文件-预览 API
访问预览文件
创建文件预览缓存
文件-协同编辑文件管理 API
访问协同编辑文件
创建协同文件
创建协同文件副本
删除协同文件
文件-导入导出 API
文件导入
文件导入说明
创建导入任务
获取导入进度
创建导入任务(旧版)
获取导入进度(旧版)
文件导出
文件导出流程
创建导出任务
获取导出进度
文件-表格文件(Excel) API
表格接口参数说明
获取表格内容
获取表格中的评论数
更新表格内容
追加表格内容
删除表格行
新增表格工作表
文件-文稿文件(Word) API
文稿书签说明
读取文稿书签内容
替换文稿书签内容
文件-文档文件(类 Markdown) API
获取文档中的评论列表
文件-应用表格文件(多维表格)API
应用表格列及单元格值结构
应用表格接口调用规则
获取数据表列表
创建数据表
获取字段列表
创建字段
更新字段
删除字段
新增行
获取单行
更新行
删除行
文件-获取额外信息 API
获取文件的纯文本内容
文件纯文本字数统计
获取文件的历史列表
获取文件的版本列表
获取文件内容中所有的 @ 人信息列表
还原文件历史版本
系统管理 API
应用管理
获取应用详情
更新应用回调地址
用户席位管理
用户席位状态说明
获取用户列表和席位状态
GET
激活用户席位
POST
取消用户席位
POST
批量设置用户席位
POST
其他 API
上报事件
创建行为历史
推送文件内全部的用户
推送用户全部的 websocket 连接
获取行列表
GET
08. 回调接口(你的应用需实现的接口)
整体概述
文件信息
文件权限说明
[重要] 获取文件元信息-协同文档
[重要] 获取文件元信息-预览文档
获取当前用户的文件列表
获取文件的协作者列表
获取接入方指定文件的完整访问地址
获取文件元 信息-协同文档自动任务(admin)
根据指定用户获取文件元信息-协同文档(admin)
用户信息
批量获取用户信息(admin)
[重要] 获取当前用户信息
获取当前用户所在团队信息
获取指定用户信息
获取用户水印信息
获取用户部门路径
批量获取用户信息
团队和部门
特殊部门 ID 说明
获取团队下的成员列表
获取部门信息
获取部门的下级部门节点
获取部门下的成员分页列表
搜索功能
获取与文件相关的用户列表
获取与文件相关的文件列表
按关键字搜索文件和用户列表
事件推送
整体概述
评论(Comment)
轻文档
添加评论
删除评论
结束评论
对于评论的回复评论
表格
添加评论
删除评论
结束评论
对于评论的回复评论
传统文档
对于评论的回复评论
添加评论
更新评论
删除评论
幻灯片
添加评论
删除评论
结束评论
对于评论的回复评论
应用表格
添加评论
对于评论的回复评论
删除评论
讨论(Discussion)
轻文档
发送讨论消息
提及(MentionAt @ 人)
轻文档
在评论中 at
在讨论中 at
在正文中 at
表格
在评论中 at
在正文中 at
传统文档
在评论中 at
在正文中 at
应用表格
在评论中 at
在正文中 at
日期提醒 (DateMention)
轻文档
创建
修改
删除
表格
创建
修改
删除
传统文档
创建
修改
删除
文件内容更新 (FileContent)
文件内容更新
文档协作者协同状态变化 (Collaborator)
文档协作者协同状态变化
文件版本 (Revision)
版本
系统事件 (System)
系统事件
回调请求错误(实验性)
回调请求错误
09. 核心模型
你的应用如何设计应用(app)模型?
你的应用如何设计文件数据模型?
你的应用如何设计通讯录模型?
你的应用系统如何设计文件权限模型?
10. 典型场景方案
云盘场景
IM 场景
示例代码仓库
11. 常见问题
访问接口提示 Signature
文件预览或导入报错
首次接入 SDK 报错
文档预览如何做防盗链
复制粘贴、全屏操作不正常
如何实现文档模板功能
文档内容何时保存
移动端不支持 blob 协议导致预览失败
如何实现文件重命名
如何通过接口修改文档内容
@人员时如何直接跳转至对应锚点
用户席位管理
复制页面
用户席位状态说明
用户席位
#
用户席位数代表可以同时使用石墨文档中台的人数(非同时在线人数)。
通常情况下,团队会出现人员变动,例如员工离职,此时为了离职员工不占用用户席位数,接入方可以使用用户席位相关接口来修改席位状态。
用户席位状态说明
#
值 域
席位状态
说明
1
激活
用户处于激活状态,占用席位数。
0
已禁用
用户已被禁用,不占用席位,必须重新激活才可以使用。
-1
未启用
用户被引用,但未实际使用文档系统,不占用席位数。
禁止重复激活
当月内同一用户仅允许激活一次
什么是"未启用"状态?
产生场景:
当您的系统集成了
@提及用户
功能时,可能会出现以下情况:
用户在@某人时,搜索到了石墨文档中台中尚未关联的用户
为了在编辑器的@下拉列表中显示这些用户,石墨文档中台会自动创建用户关联
此时这些用户的状态会被设置为"未启用"
重要特点:
不占用席位
:未启用状态的用户不会消耗您的席位配额
自动激活
:当用户首次执行实际操作时,会自动变为"激活"状态
自动激活触发条件:
当处于"未启用"状态的用户执行以下任一操作时,系统会自动将其激活为正式用户:
文件操作类
创建新文件
创建文件副本
进入编辑页面
内容处理类
导入文件
导出文件
预览文件
调用表格内容操作接口
信息获取类
获取文件历史记录
获取文件版本信息
获取文件纯文本内容
获取文件@人员列表
获取文件评论数据
注意事项:
自动激活时会尝试占用席位配额,如果席位不足,该用户将被拒绝访问。
修改于
2026-06-22 02:43:30
上一页
更新应用回调地址
下一页
获取用户列表和席位状态