乐享知识库接口文档 企业/组织开通事件回调后,可接收知识的新增、编辑、删除回调,与自有系统进行对接。由开放接口触发的变更不会发送回调。
事件类型:entry/add
{
"nonce": "d91ad49c-af97-4d58-8976-0642a9c263ce",
"timestamp": 1632279049,
"sign": "be51fc15efe09f326d16d52455d6859aacb7a434",
"operator": "StaffID",
"is_anonymous": false,
"operator_info": {
"name": "StaffID"
},
"action": "entry/add",
"attributes": {
"entry_id": "e41e07661b4f11ecae1efa828732a477",
"entry_type": "page",
"name": "产品说明",
"space_id": "fe604f859a7d495fbb5f0d477f655a4b",
"edited_by": "zhangsan"
}
}
| 参数 | 说明 |
|---|---|
| entry_id | 知识ID |
| name | 知识名称 |
| space_id | 知识所属知识库ID |
| edited_by | 编辑人账号,见下方关于 edited_by |
| entry_type | 节点类型 folder: 文件夹 file: 文件 video: 视频 audio: 音频 page: 线上文档 smartsheet: 智能表格 faq: 问答对 |
事件类型:entry/parse_finish
知识解析到达终态(解析成功、解析失败、不可解析)时回调一次;解析中、未开始解析不回调。可用 获取知识详情 的 parse_status 字段查询当前解析状态。
{
"nonce": "d91ad49c-af97-4d58-8976-0642a9c263ce",
"timestamp": 1632279049,
"sign": "be51fc15efe09f326d16d52455d6859aacb7a434",
"operator": "StaffID",
"is_anonymous": false,
"operator_info": {
"name": "StaffID"
},
"action": "entry/parse_finish",
"attributes": {
"entry_id": "e41e07661b4f11ecae1efa828732a477",
"status": "failed",
"failed_reason": "parse_quota_exhausted"
}
}
| 参数 | 说明 |
|---|---|
| entry_id | 知识ID |
| status | 解析结果 finished: 解析成功 failed: 解析失败 unsupported: 不可解析(格式不支持、文件过大、页数超限、内容为空、字数超限、音视频过长等) |
| failed_reason | 解析失败或不可解析的原因错误码 parse_quota_exhausted: 解析用量不足 space_parse_quota_exhausted: 知识库解析用量不足 其他取值见对应解析失败原因;解析成功时为空字符串 |
草稿(未发布)状态的知识不会进入解析,因此不会触发本条回调;其解析状态可通过详情接口查询,返回
unsupported与原因码document_unshelved。
事件类型:entry/edit
{
"nonce": "3378524b-781e-4414-a34d-df40f2998e4c",
"timestamp": 1632279190,
"sign": "7fe2941b4da617e4f6830747558039f9a8888244",
"operator": "StaffID",
"is_anonymous": false,
"operator_info": {
"name": "StaffID"
},
"action": "entry/edit",
"attributes": {
"after": {
"entry_id": "e41e07661b4f11ecae1efa828732a477",
"entry_type": "page",
"name": "产品说明(新)",
"space_id": "fe604f859a7d495fbb5f0d477f655a4b",
"edited_by": "zhangsan"
},
"before": {
"entry_id": "e41e07661b4f11ecae1efa828732a477",
"entry_type": "page",
"name": "产品说明",
"space_id": "fe604f859a7d495fbb5f0d477f655a4b",
"edited_by": "lisi"
}
}
}
| 参数 | 说明 |
|---|---|
| after | 编辑后的知识 |
| after.entry_id | 知识ID |
| after.name | 知识名称 |
| after.space_id | 知识所属知识库ID |
| after.entry_type | 节点类型,取值同新增知识的entry_type |
| after.edited_by | 编辑人账号,见下方关于 edited_by |
| before | 编辑前的知识。没有编辑前数据时不返回 |
| before.entry_id | 知识ID |
| before.name | 知识名称 |
| before.space_id | 知识所属知识库ID |
| before.entry_type | 节点类型,取值同新增知识的entry_type |
| before.edited_by | 编辑人账号,见下方关于 edited_by |
事件类型:entry/delete
{
"nonce": "1c382163-983f-435a-96b6-0d332f524dd7",
"timestamp": 1632279264,
"sign": "8ea1c7686a4fc11ada7003d7120b7cd06e315f42",
"operator": "StaffID",
"is_anonymous": false,
"operator_info": {
"name": "StaffID"
},
"action": "entry/delete",
"attributes": {
"entry_id": "e41e07661b4f11ecae1efa828732a477",
"entry_type": "page",
"name": "产品说明",
"space_id": "fe604f859a7d495fbb5f0d477f655a4b",
"edited_by": "zhangsan"
}
}
| 参数 | 说明 |
|---|---|
| entry_id | 知识ID |
| name | 知识名称 |
| space_id | 知识所属知识库ID |
| edited_by | 编辑人账号,见下方关于 edited_by |
| entry_type | 节点类型,取值同新增知识的entry_type |
edited_by 表示本次内容实际由谁修改,与顶层 operator 可能不同:
| 场景 | operator | edited_by |
|---|---|---|
| 普通编辑 | 编辑人 | 编辑人(两者一致) |
| 版本还原 | 还原操作人 | 还原后版本的创建人 |
| 审批知识库重新上传(审批通过) | 实际上传文件的成员 | 实际上传文件的成员(两者一致) |
两者均为企业可识别账号,格式与 operator 一致。
operator 与 edited_by 均为上传人(不再记为完成审批的审批人),接收端可直接用 operator 判断「谁改的内容」。operator 是执行还原的人,edited_by 是还原后版本的创建人,两者可能不同;需要追溯内容原作者时取 edited_by。