对于与 文档命令服务 的交互,使用POST请求。 请求参数在请求正文中以 JSON 格式输入请求被发送到 https://documentserver/coauthoring/CommandService.ashx, 其中 documentserver 是安装了ONLYOFFICE 文档服务器的服务器的名称
请参阅下面可用的命令类型以了解更多信息。
命令 | 描述 |
deleteForgotten | 该命令允许删除被遗忘的文件。 |
drop | 此命令允许断开指定用户与文档编辑服务的连接。 |
forcesave | 此命令允许强制保存正在编辑的文档,而无需关闭它。 |
getForgotten | 该命令允许请求一个被遗忘的文件。 |
getForgottenList | 此命令允许请求被遗忘文件的列表。 |
info | 此命令允许请求一个文档的状态以及打开编辑过该文档的用户标识符列表。 |
license | 此命令允许从文档服务器请求许可证,并提供有关服务器和用户配额的信息。 |
meta | 此命令允许为所有协作编辑器更新文档的元信息。 |
vesion | 此命令允许请求文档服务器的当前版本号。 |
JSON Web令牌应以JSON对象格式发送到 文档命令服务它用于接收具有指定键的文档的状态。
{ "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjIjoiaW5mbyIsImtleSI6IktoaXJ6NnpUUGRmZDcifQ.r_6sThjFABsHMNHhkVdHDSz4jwkbXRQNYdvawkBGJgg" }
名称 | 描述 | 类型 | 出现 |
token | 定义以 令牌形式添加到 文档服务器 配置的加密签名 | string | 配置所需 |
文档编辑服务 将命令产生的结果通知 文档存储服务,并通过 回调处理程序发送包含所有必要数据的响应。
错误代码 | 描述 |
0 | 没有错误。 |
1 | 文档密钥缺失或找不到具有该密钥的文档。 |
2 | 回调url不正确。 |
3 | 内部服务器错误。 |
4 | 在收到 forcesave 命令之前,未对文档应用任何更改。 |
5 | 命令不正确。 |
6 | 令牌无效。 |