服务端 API/审批/概述 # 概述 ## 业务介绍 Lark审批通过提供一站式、高效率的审批解决方案，帮助企业解决各种审批难题，轻松解锁高效愉悦的审批人体验。Lark审批可以快速建立企业内部审批流程，如请假、出差等。审批开放接口可以对审批实例进行查询和创建，可用于企业原有平台与审批打通。我们提供了一系列安全、可靠的 API，来方便你对审批信息进行操作，通过审批 API，你可以实现多种功能，例如： - Lark原生审批接入 - 三方审批系统接入 - Lark应用接入审批 ### 接入流程 编号 | 步骤 | 介绍 ---|---|--- 1 | 创建一个应用 | 如需创建企业自建应用，可参考 [自建应用的开发流程](https://open.larksuite.com/document/home/introduction-to-custom-app-development/self-built-application-development-process)如需创建应用商店应用，可参考 [开发和上架应用商店应用](https://open.larksuite.com/document/uMzNwEjLzcDMx4yM3ATM/uYzNwEjL2cDMx4iN3ATM) 2 | 调用API，对审批进行操作 | 调用API前，你需要先获取访问凭证并开启对应的权限，详情参见 [如何调用服务端API](https://open.larksuite.com/document/ukTMukTMukTM/uITNz4iM1MjLyUzM)。 3 | 监听事件，获知审批状态的变化 | 监听事件前，你需要先申请相应的权限，[审批事件监听开发指南](https://open.larksuite.com/document/ukTMukTMukTM/ugDNyUjL4QjM14CO0ITN) ### 开发教程 教程名称 | 教程步骤拆解 ---|--- [快速开发三方审批](https://open.larksuite.com/document/home/quickly-develop-three-party-approvals/introduction)
![](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/7e3dbfdaaeac897ce0949076621a69c0_QqSOUFSBky.jpeg?height=600&lazyload=true&width=1128) | 教程步骤拆解
1. [简介](https://open.larksuite.com/document/home/quickly-develop-three-party-approvals/introduction)
2. [准备工作](https://open.larksuite.com/document/home/quickly-develop-three-party-approvals/prep-work)
3. [创建应用和申请权限](https://open.larksuite.com/document/home/quickly-develop-three-party-approvals/creating-applications-and-requesting-permissions)
4. [获取访问凭证](https://open.larksuite.com/document/home/quickly-develop-three-party-approvals/get-access-token)
5. [创建和更新三方审批定义](https://open.larksuite.com/document/home/quickly-develop-three-party-approvals/create-and-update-three-party-approval-definitions)
6. [三方审批实例同步](https://open.larksuite.com/document/home/quickly-develop-three-party-approvals/three-party-approval-instance-synchronization)
7. [发送与更新审批bot消息](https://open.larksuite.com/document/home/quickly-develop-three-party-approvals/send-and-update-approval-bot-messages)
8. [三方快捷审批](https://open.larksuite.com/document/home/quickly-develop-three-party-approvals/three-party-expedited-approval)
9. [三方审批实例校验](https://open.larksuite.com/document/home/quickly-develop-three-party-approvals/three-party-approval-example-verification) ## 资源介绍 资源的定义如下： 资源 | 资源定义 ---|--- [审批定义](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/overview-of-approval-resources) | 单个审批流，由表单和审批流程组成，创建后可以让员工在发起审批时填写各个控件的值并形成[审批实例](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/overview-approval-instance)。 [审批实例](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/overview-approval-instance) | 员工发起审批时产生的审批流。包括多个[审批任务](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/introduction) [审批任务](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/introduction) | 审批任务依赖于审批节点存在，每一个审批节点可能包含有一或多个审批任务，每一个任务表明当前审批节点的审批人是谁 [审批评论](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/overview) | 员工在审批实例中进行的评论或评论回复。 [文件](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/file/overview) | 当审批表单中有图片或附件控件时，开发者需在创建审批实例前通过审批上传文件接口将文件上传到审批系统。 [三方审批定义](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/overview) | 三方审批定义是审批的描述，包括审批名称、图标、描述、分组等基础信息。三方将根据三方审批定义来创建和同步[三方审批实例](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/overview) [三方审批实例](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/overview) | 员工发起审批时产生的审批流。包括多个审批任务、审批抄送等信息 [三方审批任务](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/overview) | 审批人每一个审批的操作对应着一个审批任务 以下将详细介绍每个资源的字段、方法、事件。 ### 资源：审批定义 Approval 查看资源 [字段及示例](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/overview-of-approval-resources) #### 方法列表 **[方法 (API)](https://open.larksuite.com/document/ukTMukTMukTM/uITNz4iM1MjLyUzM)** | 权限要求 | **[访问凭证](https://open.larksuite.com/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)** ---|---|--- [创建审批定义](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/create)
`POST` /open-apis/approval/v4/approval | 查看、创建、更新、删除审批应用相关信息(approval:approval) | `tenant_access_token` [查看审批定义](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/get)
`GET` /open-apis/approval/v4/approvals/:approval_code | 访问审批应用(approval:approval:readonly) | `tenant_access_token` [订阅审批事件](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/subscribe)
`POST` /open-apis/approval/v4/:approval_code/subscribe | 查看、创建、更新、删除审批应用相关信息(approval:approval) | `tenant_access_token` [取消订阅审批事件](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/unsubscribe)
`POST` /open-apis/approval/v4/:approval_code/unsubscribe | 查看、创建、更新、删除审批应用相关信息(approval:approval) | `tenant_access_token` ### 资源：审批实例 Instance 查看资源 [字段及示例](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/overview-approval-instance) #### 方法列表 **[方法 (API)](https://open.larksuite.com/document/ukTMukTMukTM/uITNz4iM1MjLyUzM)** | 权限要求 | **[访问凭证](https://open.larksuite.com/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)** ---|---|--- [创建审批实例](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/create)
`POST` /open-apis/approval/v4/instances | 查看、创建、更新、删除审批应用相关信息(approval:approval) | `tenant_access_token` [批量获取审批实例ID](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list)
`GET` /open-apis/approval/v4/instances | 访问审批应用(approval:approval:readonly) | `tenant_access_token` [获取单个审批实例详情](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/get)
`GET` /open-apis/approval/v4/instances/:instance_id | 访问审批应用(approval:approval:readonly) | `tenant_access_token` [审批实例抄送](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cc)
`POST` /open-apis/approval/v4/instances/cc | 访问审批应用(approval:approval:readonly) | `tenant_access_token` [审批实例撤回](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cancel)
`POST` /open-apis/approval/v4/instances/cancel | 访问审批应用(approval:approval:readonly) | `tenant_access_token` [审批流程预览](https://open.larksuite.com/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-preview)
`POST` /open-apis/approval/v4/instances/preview | 访问审批应用(approval:approval:readonly) | `tenant_access_token` #### 事件列表 **[事件（event）](https://open.larksuite.com/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM)** | 权限要求 | **触发时机** ---|---|--- [审批定义更新](https://open.larksuite.com/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/custom-approval-event) | 访问审批应用(approval:approval:readonly) | 审批定义变更 [审批实例更新](https://open.larksuite.com/document/ukTMukTMukTM/ugDNyUjL4QjM14CO0ITN) | 访问审批应用(approval:approval:readonly) | 审批实例状态变更 [审批任务更新](https://open.larksuite.com/document/ukTMukTMukTM/ugDNyUjL4QjM14CO0ITN) | 访问审批应用(approval:approval:readonly) | 审批任务状态变更 [请假审批](https://open.larksuite.com/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/leave) | 访问审批应用(approval:approval:readonly) | 「审批」应用的表单里如果包含 请假控件组，则在此表单审批通过后触发此事件 [加班审批](https://open.larksuite.com/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/overtime) | 访问审批应用(approval:approval:readonly) | 「审批」应用的表单里如果包含 加班控件组，则在此表单审批通过后触发此事件 [换班审批](https://open.larksuite.com/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/shift-change) | 访问审批应用(approval:approval:readonly) | 「审批」应用的表单包含换班控件组的，换班申请审批通过后触发此事件 [补卡审批](https://open.larksuite.com/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/attendance-record-correction) | 访问审批应用(approval:approval:readonly) | 补卡申请审批通过后触发此事件。 你可以在「打卡」应用里提交补卡申请 [出差审批](https://open.larksuite.com/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/business-trip) | 访问审批应用(approval:approval:readonly) | 「审批」应用的表单里如果包含 出差控件组，则在此表单审批通过后触发此事件 [外出审批事件](https://open.larksuite.com/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/out-of-office) | 访问审批应用(approval:approval:readonly) | 「审批」应用的表单里如果包含 外出控件组，则在此表单审批通过后触发此事件 ### 资源：审批任务 Task 查看资源 [字段及示例](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/introduction) #### 方法列表 **[方法 (API)](https://open.larksuite.com/document/ukTMukTMukTM/uITNz4iM1MjLyUzM)** | 权限要求 | **[访问凭证](https://open.larksuite.com/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)** ---|---|--- [审批任务同意](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/approve)
`POST` /open-apis/approval/v4/tasks/approve | 访问审批应用(approval:approval:readonly) | `tenant_access_token` [审批任务拒绝](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/reject)
`POST` /open-apis/approval/v4/tasks/reject | 访问审批应用(approval:approval:readonly) | `tenant_access_token` [审批任务转交](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/transfer)
`POST` /open-apis/approval/v4/tasks/transfer | 访问审批应用(approval:approval:readonly) | `tenant_access_token` [审批任务退回](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/specified_rollback)
`POST` /open-apis/approval/v4/tasks/specified_rollback | 访问审批应用(approval:approval:readonly) | `tenant_access_token` [审批任务加签](https://open.larksuite.com/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-task-addsign)
`POST` /open-apis/approval/v4/tasks/add_sign | 访问审批应用(approval:approval:readonly) | `tenant_access_token` ### 资源：审批评论 Comment 查看资源 [字段及示例](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/overview) #### 方法列表 **[方法 (API)](https://open.larksuite.com/document/ukTMukTMukTM/uITNz4iM1MjLyUzM)** | 权限要求 | **[访问凭证](https://open.larksuite.com/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)** ---|---|--- [创建评论](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/create)
`POST` /open-apis/approval/v4/instances/:instance_id/comments | 查看、创建、更新、删除审批应用相关信息(approval:approval) | `tenant_access_token` [获取评论](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/list)
`GET` /open-apis/approval/v4/instances/:instance_id/comments | 查看、创建、更新、删除审批应用相关信息(approval:approval)
Access Approval(approval:approval:readonly) | `tenant_access_token` [删除评论](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/delete)
`DELETE` /open-apis/approval/v4/instances/:instance_id/comments/:comment_id | 查看、创建、更新、删除审批应用相关信息(approval:approval) | `tenant_access_token` [清空评论](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/remove)
`POST` /open-apis/approval/v4/instances/:instance_id/comments/remove | 查看、创建、更新、删除审批应用相关信息(approval:approval) | `tenant_access_token` ### 资源：三方审批定义 External Approval 查看资源 [字段及示例](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/overview) #### 方法列表 **[方法 (API)](https://open.larksuite.com/document/ukTMukTMukTM/uITNz4iM1MjLyUzM)** | 权限要求 | **[访问凭证](https://open.larksuite.com/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)** ---|---|--- [三方审批定义创建](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/create)
`POST` /open-apis/approval/v4/external_approvals | 查看、创建、更新、删除审批应用相关信息(approval:approval) | `tenant_access_token` ### 资源：三方审批实例 External Instance 查看资源 [字段及示例](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/overview) #### 方法列表 **[方法 (API)](https://open.larksuite.com/document/ukTMukTMukTM/uITNz4iM1MjLyUzM)** | 权限要求 | **[访问凭证](https://open.larksuite.com/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)** ---|---|--- [三方审批实例同步](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/create)
`POST` /open-apis/approval/v4/external_instances | 查看、创建、更新、删除审批应用相关信息(approval:approval) | `tenant_access_token` [三方审批实例校验](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/check)
`POST` /open-apis/approval/v4/external_instances/check | 访问审批应用(approval:approval:readonly) | `tenant_access_token` ### 资源：三方审批任务 Exteranl Task 查看资源 [字段及示例](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/overview) #### 方法列表 **[方法 (API)](https://open.larksuite.com/document/ukTMukTMukTM/uITNz4iM1MjLyUzM)** | 权限要求 | **[访问凭证](https://open.larksuite.com/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)** ---|---|--- [获取三方审批任务状态](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list)
`GET` /open-apis/approval/v4/external_tasks | 访问审批应用(approval:approval:readonly) | `tenant_access_token`