| 作者 | 日期 | 说明 |
|---|---|---|
| 雨中星辰 | 2021-09-11 | 基于当前最新版本v6.3编写 |
对于与文档命令服务的交互，使用 POST 请求。请求参数在请求正文中以 JSON 格式输入。请求被发送到https://documentserver/coauthoring/CommandService.ashx地址，其中documentserver是安装了 ONLYOFFICE 文档服务器的服务器的名称。
在4.2 版之前的ONLYOFFICE 文档服务器中，使用了带有QueryString参数的 GET 请求。
参数及其说明：
| 范围 | 描述 | 类型 | 在场 |
|---|---|---|---|
| C | 定义命令的类型。 支持的值：drop - 使用users参数中存在的标识符将用户与文档编辑服务断开连接（这些用户将能够查看文档，但不允许对其进行更改）；forceave - 强制保存正在编辑的文档而不关闭它（在此命令之后可能会继续编辑文档，因此这不是最终保存的文档版本）；info - 接收文档状态和打开文档进行编辑的用户的标识符列表；meta - 为所有协作编辑器更新文档的元信息；version - 接收文件服务器的当前版本号。 | 细绳 | 必需的 |
| 钥匙 | 定义用于明确标识文档文件的文档标识符。 | 细绳 | 必需的 |
| 元 | 定义文档的新元信息（用于c=meta参数值）。 | 细绳 | 必需的 |
| 元标题 | 定义文档的新名称（用于c=meta参数值）。 | 细绳 | 必需的 |
| 令牌 | 定义以令牌形式添加到文件服务器配置的加密签名。 | 细绳 | 配置要求 |
| 用户数据 | 定义一些自定义标识符，这将有助于区分特定请求，以防有多个请求。 | 细绳 | 可选的 |
| 用户 | 定义用户标识符列表（用于c=drop参数值）。 | 字符串数组 | 可选的 |
发送到文档命令服务的 JSON 对象示例，用于断开具有6d5a81d0标识符的用户与文档编辑服务的连接
{
"c": "drop",
"key": "Khirz6zTPdfd7",
"users": [ "6d5a81d0" ]
}
请求结果以JSON形式返回。
响应示例
{
"c": "drop",
"key": "Khirz6zTPdfd7",
"users": [ "6d5a81d0" ]
}
发送到文档命令服务的 JSON 对象示例，用于强制保存带有6d5a81d0标识符的文档而不关闭它
{
"c": "forcesave",
"key": "Khirz6zTPdfd7",
"userdata": "sample userdata"
}
请求结果以JSON形式返回。
响应示例
{
"error": 0,
"key": "Khirz6zTPdfd7"
}
发送到文档命令服务的 JSON 对象示例，用于接收带有Khirz6zTPdfd7标识符的文档状态
{
"c": "info",
"key": "Khirz6zTPdfd7"
}
请求结果以JSON形式返回。
响应示例
{
"error": 0,
"key": "Khirz6zTPdfd7"
}
发送到文档命令服务的 JSON 对象示例，用于使用Khirz6zTPdfd7标识符更新文档名称
{
"c": "meta",
"key": "Khirz6zTPdfd7",
"meta": {
"title": "Example Document Title.docx"
}
}
请求结果以JSON形式返回。
响应示例
{
"error": 0,
"key": "Khirz6zTPdfd7"
}
发送到文档命令服务的 JSON 对象示例，用于接收文档服务器的当前版本号
{
"c": "version"
}
version的请求结果以JSON形式返回。
响应示例
{
"error": 0,
"version": "4.3.1.4"
}
JSON 对象示例包含发送到文档命令服务的 JSON Web 令牌，用于接收带有Khirz6zTPdfd7标识符的文档状态
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjIjoiaW5mbyIsImtleSI6IktoaXJ6NnpUUGRmZDcifQ.r_6sThjFABsHMNHhkVdHDSz4jwkbXRQNYdvawkBGJgg"
}
该文档编辑服务通知文件存储服务有关使用通过命令造成的结果回调处理程序。
可能的错误代码及其描述
| 错误代码 | 描述 |
|---|---|
| 0 | 没有错误。 |
| 1 | 文档密钥丢失或找不到具有此类密钥的文档。 |
| 2 | 回调网址不正确。 |
| 3 | 内部服务器错误。 |
| 4 | 在收到forceave命令之前，未对文档应用任何更改。 |
| 5 | 命令不正确。 |
| 6 | 令牌无效。 |
实际示例：
image.png
image.png
