乐享知识库接口文档 企业/组织开通事件回调后,可接收审批的发起、撤回、催办、通过、拒绝、完成回调,与自有系统(如 OA 待办)进行对接。由开放接口触发的变更不会发送回调。
审批流程由「执行单」和「审批任务」两层构成:一次审批发起对应一条执行单,执行单下每个节点为每位审批人生成一条审批任务。 发起/撤回/催办/完成作用于执行单,通过/拒绝作用于审批任务。
execution_id关联同一次审批的全部事件。
事件类型:approval/apply
执行单创建并派发到首个审批节点时触发,每次审批仅触发一次(后续节点流转不再重复触发)。
{
"nonce": "8c1f4a52-3d7e-4b1a-9f2c-6e5d8a7b1c30",
"timestamp": 1793254963,
"sign": "299744be4ddea11e80633827cf97d2a9afff0ddf",
"operator": "zhangsan",
"is_anonymous": false,
"operator_info": {
"name": "zhangsan"
},
"action": "approval/apply",
"attributes": {
"execution_id": "f203310052244a9fbc173e468461409b",
"definition_id": "2788b0fa41e9490e87be3517705c07c2",
"created_by": "zhangsan",
"space_id": "aa38123fd5eb490bb42b222adb2a6e74",
"target_type": "kb_entry",
"target_id": "98559125f3674ff585bd083b41416a12",
"step": 1,
"status": 0,
"assignees": ["lisi", "wangwu"],
"url": "https://lexiangla.com/pages/98559125f3674ff585bd083b41416a12/workflow/f203310052244a9fbc173e468461409b?company_from=xxx"
}
}
| 参数 | 说明 |
|---|---|
| execution_id | 审批执行单 ID,同一次审批的所有事件共用此 ID |
| definition_id | 审批流程定义 ID |
| created_by | 审批发起人账号 |
| space_id | 知识库 ID(审批对象位于知识库时返回) |
| target_type | 审批对象类型,如 kb_entry(知识) |
| target_id | 审批对象 ID,kb_entry 时为知识 ID |
| step | 当前审批节点序号,从 1 开始 |
| status | 执行单状态 0: 进行中 1: 通过 2: 拒绝 3: 撤回 |
| assignees | 待审批人账号列表 |
| url | 审批详情页链接,可直接跳转至审批页面 |
事件类型:approval/withdraw
发起人撤回审批时触发。
{
"nonce": "10c84590-e5b4-407c-869d-e2e8c8d3a52e",
"timestamp": 1793255001,
"sign": "8f6021e0dd0a7aebe4deb9dae835251c6f8817c3",
"operator": "zhangsan",
"is_anonymous": false,
"operator_info": {
"name": "zhangsan"
},
"action": "approval/withdraw",
"attributes": {
"execution_id": "f203310052244a9fbc173e468461409b",
"definition_id": "2788b0fa41e9490e87be3517705c07c2",
"created_by": "zhangsan",
"space_id": "aa38123fd5eb490bb42b222adb2a6e74",
"target_type": "kb_entry",
"target_id": "98559125f3674ff585bd083b41416a12",
"step": 1,
"status": 3,
"url": "https://lexiangla.com/pages/98559125f3674ff585bd083b41416a12/workflow/f203310052244a9fbc173e468461409b?company_from=xxx"
}
}
字段同「发起审批」,status 为 3(已撤回)。撤回不产生「完成审批」事件。
事件类型:approval/urge
发起人对审批人发起催办时触发。
{
"nonce": "4d2b8e9f-1a3c-4f5d-8e7b-2c9a1f3d5e6b",
"timestamp": 1793255120,
"sign": "5d8a3f0c7b1e2946a8d5c3f1e7b49d0a6c2f8e35",
"operator": "zhangsan",
"is_anonymous": false,
"operator_info": {
"name": "zhangsan"
},
"action": "approval/urge",
"attributes": {
"execution_id": "f203310052244a9fbc173e468461409b",
"definition_id": "2788b0fa41e9490e87be3517705c07c2",
"created_by": "zhangsan",
"space_id": "aa38123fd5eb490bb42b222adb2a6e74",
"target_type": "kb_entry",
"target_id": "98559125f3674ff585bd083b41416a12",
"step": 2,
"status": 0,
"assignees": ["lisi"],
"url": "https://lexiangla.com/pages/98559125f3674ff585bd083b41416a12/workflow/f203310052244a9fbc173e468461409b?company_from=xxx"
}
}
字段同「发起审批」,assignees 为被催办的审批人。
事件类型:approval/approve
审批人在自己的审批任务上点击「同意」时触发。
会签场景下每位审批人各触发一次:N 位审批人全部通过,则产生 N 条
approval/approve。或签场景由第一位审批人通过即推进节点。
{
"nonce": "7f3a2b81-6c4d-4e9a-b1f8-3d5c7a9e2b46",
"timestamp": 1793255200,
"sign": "9e1c4a7f3b8d2056c9a4e7f1d3b8a502c6f9e174",
"operator": "lisi",
"is_anonymous": false,
"operator_info": {
"name": "lisi"
},
"action": "approval/approve",
"attributes": {
"execution_id": "f203310052244a9fbc173e468461409b",
"task_id": "a54dfccd34c94a998f88597617fad69c",
"assignee": "lisi",
"approved_by": "lisi",
"task_status": 1,
"step": 1,
"node_id": "e7c1a2b3d4f5468a9b0c1d2e3f4a5b6c",
"act_type": "or",
"created_by": "zhangsan",
"space_id": "aa38123fd5eb490bb42b222adb2a6e74",
"target_type": "kb_entry",
"target_id": "98559125f3674ff585bd083b41416a12",
"url": "https://lexiangla.com/pages/98559125f3674ff585bd083b41416a12/workflow/f203310052244a9fbc173e468461409b?company_from=xxx"
}
}
| 参数 | 说明 |
|---|---|
| execution_id | 审批执行单 ID |
| task_id | 审批任务 ID |
| assignee | 被指派的审批人账号 |
| approved_by | 实际审批人账号,自动通过时可能为空 |
| task_status | 审批任务状态 1: 通过 2: 拒绝 |
| step | 该审批任务所属节点序号 |
| node_id | 审批节点 ID |
| act_type | 审批节点类型 or: 或签(任一人通过即可) and: 会签(需全部通过) |
| created_by | 审批发起人账号 |
| space_id | 知识库 ID(审批对象位于知识库时返回) |
| target_type | 审批对象类型 |
| target_id | 审批对象 ID |
| url | 审批详情页链接 |
事件类型:approval/reject
审批人在自己的审批任务上点击「拒绝」时触发,执行单随即进入拒绝终态。
{
"nonce": "2b9d5e7a-8f1c-4a3b-9d6e-5c2f8a1b7d43",
"timestamp": 1793255300,
"sign": "3a7f9c1e5b8d2046f9a3c7e1b5d8a402c6f7e193",
"operator": "lisi",
"is_anonymous": false,
"operator_info": {
"name": "lisi"
},
"action": "approval/reject",
"attributes": {
"execution_id": "f203310052244a9fbc173e468461409b",
"task_id": "a54dfccd34c94a998f88597617fad69c",
"assignee": "lisi",
"approved_by": "lisi",
"task_status": 2,
"step": 1,
"node_id": "e7c1a2b3d4f5468a9b0c1d2e3f4a5b6c",
"act_type": "or",
"created_by": "zhangsan",
"space_id": "aa38123fd5eb490bb42b222adb2a6e74",
"target_type": "kb_entry",
"target_id": "98559125f3674ff585bd083b41416a12",
"url": "https://lexiangla.com/pages/98559125f3674ff585bd083b41416a12/workflow/f203310052244a9fbc173e468461409b?company_from=xxx"
}
}
字段同「通过审批」,task_status 为 2(拒绝)。
事件类型:approval/complete
审批执行单到达终态时触发,表示整个审批流程结束。每次审批最多触发一次,status 区分最终结果。
{
"nonce": "6e2c9a4f-7b1d-4f8a-9c3e-1d5b7a2c9e84",
"timestamp": 1793255400,
"sign": "c4f8a2e6b1d39570a4c8e2f6b1d9a305e7c1f842",
"operator": "lisi",
"is_anonymous": false,
"operator_info": {
"name": "lisi"
},
"action": "approval/complete",
"attributes": {
"execution_id": "f203310052244a9fbc173e468461409b",
"definition_id": "2788b0fa41e9490e87be3517705c07c2",
"created_by": "zhangsan",
"space_id": "aa38123fd5eb490bb42b222adb2a6e74",
"target_type": "kb_entry",
"target_id": "98559125f3674ff585bd083b41416a12",
"step": 2,
"status": 1,
"url": "https://lexiangla.com/pages/98559125f3674ff585bd083b41416a12/workflow/f203310052244a9fbc173e468461409b?company_from=xxx"
}
}
字段同「发起审批」。status 为 1(通过)或 2(拒绝),表示最终结果。
注意:审批流程未配置审批人(或审批人被引擎全部自动通过)时,执行单会直接完成,此时会收到一条孤立的
approval/complete(没有对应的approval/apply)。请按execution_id做幂等处理,避免重复计数。
事件类型:approval/transfer
审批人把自己的审批任务转交给其他人时触发,可多次转交。
{
"nonce": "3f7c2a91-5d84-4e6b-9a18-2c7d5f8b1e39",
"timestamp": 1793255600,
"sign": "d2f6a1c8b3e9570a42d6f8c1b3e9570a42d6f8c1",
"operator": "wangwu",
"is_anonymous": false,
"operator_info": {
"name": "wangwu"
},
"action": "approval/transfer",
"attributes": {
"execution_id": "f203310052244a9fbc173e468461409b",
"target_type": "kb_entry",
"target_id": "98559125f3674ff585bd083b41416a12",
"node_id": "e7c1a2b3d4f5468a9b0c1d2e3f4a5b6c",
"created_by": "zhangsan",
"to_staff_id": "lisi",
"assignees": ["lisi"],
"transferred_staff_ids": ["wangwu"],
"reason": "出差在外,请代为审批",
"unfinished_count": 1,
"url": "https://lexiangla.com/pages/98559125f3674ff585bd083b41416a12/workflow/f203310052244a9fbc173e468461409b?company_from=xxx"
}
}
| 参数 | 说明 |
|---|---|
| execution_id | 审批执行单 ID |
| target_type | 审批对象类型,如 kb_entry(知识) |
| target_id | 审批对象 ID,kb_entry 时为知识 ID |
| node_id | 转交所在的审批节点 ID |
| created_by | 审批发起人账号 |
| to_staff_id | 本次转交的接收人账号 |
| assignees | 该节点当前的待审批人账号列表(转交后) |
| transferred_staff_ids | 该节点历史全部转出人账号,含已转回者;与 assignees 的交集表示转回者 |
| reason | 转交原因 |
| unfinished_count | 该执行单未完成计数 |
| url | 审批详情页链接 |
转交成功后,转出人即进入「已处理」,
assignees中不再包含转出人(除非被转回)。接收端应以本事件的assignees与transferred_staff_ids更新待办归属。
事件类型:approval/cc
审批过程中新增抄送人时触发,仅对本次实际新增的成员发出一条;重复添加同一人不会重复触发。
{
"nonce": "9a4e2b73-1c58-4f9d-8b26-5e3a7c1d9f48",
"timestamp": 1793255700,
"sign": "5c8b2e7a1d946f03b5c8e2d7a1f946b03c5e8d2a",
"operator": "zhangsan",
"is_anonymous": false,
"operator_info": {
"name": "zhangsan"
},
"action": "approval/cc",
"attributes": {
"execution_id": "f203310052244a9fbc173e468461409b",
"target_id": "98559125f3674ff585bd083b41416a12",
"node_id": "e7c1a2b3d4f5468a9b0c1d2e3f4a5b6c",
"staff_ids": ["lisi", "wangwu"],
"reason": "需要知会",
"url": "https://lexiangla.com/pages/98559125f3674ff585bd083b41416a12/workflow/f203310052244a9fbc173e468461409b?company_from=xxx"
}
}
| 参数 | 说明 |
|---|---|
| execution_id | 审批执行单 ID |
| target_id | 审批对象 ID,kb_entry 时为知识 ID |
| node_id | 抄送所在的审批节点 ID |
| staff_ids | 本次新增的抄送人账号列表 |
| reason | 抄送原因 |
| url | 审批详情页链接 |
抄送人只可见、可评论,不参与审批流转,不会出现在待审批人(
assignees)中。
approval/apply(发起,step=1)
├─ approval/urge(催办,可多次)
├─ approval/approve × N(会签 N 人各一次)→ approval/complete
├─ approval/reject(拒绝)→ approval/complete
└─ approval/withdraw(撤回,不产生 complete)
多级审批流程中,节点通过后会派发下一批审批人,但不会重复触发 approval/apply;下一节点的审批人通过时照常产生 approval/approve。