钉钉 API

概述

本文介绍了OA审批产品、OA审批开放了哪些接口能力，如何接入OA审批能力以及审批案例等内容。

什么是OA审批

OA审批（智能工作流），是钉钉为企业提供的官方应用，可以快速建立审批流程，如请假、出差等。OA审批开放的接口可以对审批实例等进行操作，将企业原有的业务系统与钉钉OA审批打通。更多功能介绍，请参见钉钉使用手册-OA审批。

以下应用类型均支持接入OA审批：

企业内部应用
第三方企业应用

客户案例

更多应用场景可参考客户案例：

官方OA审批：企业系统与钉钉OA审批打通
自有OA审批：钉钉OA审批助力费控报销

名词解释

概念说明

概念	说明
审批表单	一个预定义的模板，可以包含多个表单控件。员工填写表单提交后会生成审批实例。钉钉也提供了一系列通用的审批表单，例如请假、出差等，单击创建新表单可以直接使用。管理员可在OA审批管理后台页面查看所有审批表单。
审批表单控件	钉钉提供了丰富的审批表单控件，方便用户快捷定制审批表单。您可以新建或编辑已有的审批表单，单击表单设计，可新增或修改控件。请假表单的控件如下图所示。
审批流程	用户可以根据实际需求设计审批流程，例如设置审批人、审批条件等。
审批实例	企业用户发起一个审批，即会产生一个审批的实例，如下图所示。每个审批实例，包含了用户在发起审批时填写的表单数据、审批人、审批人操作记录等数据。
审批节点	一个审批流程可以有多个审批节点，每一个审批节点配置一个或多个审批人，根据节点审批人的不同可以分为以下两种情况：单个审批节点只有一个审批人，在当前审批人对此审批节点执行同意或拒绝操作时，此流程节点随即结束，并自动进行下一级审批。单个审批节点有多个审批人。每一个审批人对应一个审批任务。根据多个审批人审批方式的不同，可以分为以下三种情况：多个审批人依次审批，一个审批人处理完成后按顺序自动发送审批任务给下一级审批人。多个审批人会签，需要当前审批节点所有人都执行审批通过操作后，才会流到下一节点，否则流程被拒绝。多个审批人或签，只需要当前审批节点中的一个审批人执行审批操作，当前流程节点随即结束。
审批任务	一个审批节点可以生成一个或多个审批任务。每个审批任务会表明审批人是谁，审批人接到任务后可以做同意或拒绝等操作。

ID说明

ID名称	说明
processCode	审批表单的唯一编码。可以在审批表单编辑页-基础设置-页面底部查看。
bizCategoryId	审批表单所属的业务分类标识。可通过OA审批事件的事件体或获取表单 schema 接口获取。常用的套件业务分类标识参见下方OA审批套件业务分类标识内容。

OA审批套件业务分类标识

业务分类标识 bizCategoryId	套件名称	业务名称
open.com.dd.at.approveCheck	打卡审批	考勤
attendance.batchovertime	加班	考勤
attendance.supply	补卡	考勤
attendance.goout	外出	考勤
attendance.relieve	换班	考勤
alitrip.business	出差	考勤
hrm.termination	离职	智能人事
hrm.transfer	转岗	智能人事
hrm.regular	转正	智能人事
hrm.hire	入职	智能人事
hrm.terminationAndHandover	离职&离职交接	智能人事
hrm.handOver	离职交接	智能人事
hrm.hireTrial	试岗入职	智能人事
hrm.promotion	晋升	智能人事
hrm.transferAndSalary	调岗调薪	智能人事
hrm.hireAndSalary	入职定薪	智能人事
hrm.regularAndSalary	转正调薪	智能人事
hrm.promotionAndSalary	晋升调薪	智能人事
dingtalk.hrm.offer	offer审批	智能人事
dingtalk.hrm.integratedSuite	人事综合套件	智能人事
dingtalk.businessFinance.reimbursement	报销套件	智能财务
dingtalk.businessFinance.payment	付款套件	智能财务
dingtalk.businessFinance.collection	收款套件	智能财务
dingtalk.businessFinance.receivable	应收套件	智能财务
dingtalk.businessFinance.returned	应收回款	智能财务
dingtalk.businessFinance.badDebt	应收坏账	智能财务
dingtalk.businessFinance.payable	应付套件	智能财务
dingtalk.businessFinance.payablePayment	应付实付	智能财务
dingtalk.businessFinance.noPayment	应付免付	智能财务
dingtalk.businessFinance.reserve	备用金	智能财务
dingtalk.businessFinance.reserveVerification	备用金核销	智能财务
dingtalk.businessFinance.reserveReturned	备用金还款	智能财务
dingtalk.businessFinance.transfer	转账	智能财务
dingtalk.businessFinance.invoiceApplication	开票申请	智能财务
dingtalk.businessFinance.costApplication	费用申请	智能财务
open.com.dd.suite.seal	用印申请	智能合同
open.com.dd.suite.icontract	合同审批	智能合同

OA审批开放的接口能力

OA审批开放的接口列表

OA审批提供了丰富的接口开放能力，开发者通过API接口可以实现OA审批和企业业务系统打通。

官方OA审批

审批表单

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
创建或更新审批模板	创建或更新一个OA审批的流程表单模板，可指定表单控件列表并生成默认审批流程。	创建或更新审批表单模板	创建或更新审批模板（历史版本）
获取表单 schema	通过 processCode 获取对应表单的 schema 信息。	获取表单 schema	-
获取审批单流程中的节点信息	获取审批单流程中的节点信息。	获取审批单流程中的节点信息	-
获取指定用户可见的审批表单列表	根据员工的userid分页获取该用户可见的审批表单列表。	获取指定用户可见的审批表单列表	获取指定用户可见的审批表单列表（历史版本）
获取当前企业所有可管理的表单	获取当前企业所有可管理的审批表单。	获取当前企业所有可管理的表单	获取当前企业所有可管理的表单（历史版本）

审批实例

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
发起审批实例	发起OA审批实例。	发起审批实例	发起审批实例（历史版本）
获取单个审批实例详情	根据审批实例ID，获取审批实例详情。	获取单个审批实例详情	获取单个审批实例详情（历史版本）
撤销审批实例	撤销发起的审批实例。	撤销审批实例	撤销审批实例（历史版本）
添加审批评论	对审批实例添加评论。	添加审批评论	添加审批评论（历史版本）
获取审批实例ID列表	获取权限范围内的相关部门审批实例ID列表。	获取审批实例ID列表	获取审批实例ID列表（历史版本）

审批钉盘空间&附件

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
获取审批钉盘空间信息	获取审批钉盘空间的ID并授予当前用户上传附件的权限。	获取审批钉盘空间信息	获取审批钉盘空间信息（历史版本）
授权预览审批附件	授权预览审批附件。	授权预览审批附件	授权预览审批附件（历史版本）
授权下载审批钉盘文件	根据钉盘空间spaceId和文件fileId对钉盘文件进行授权审批钉盘空间下载权限。	授权下载审批钉盘文件	授权下载审批钉盘文件（历史版本）
下载审批附件	获取审批文件下载授权，并且生成下载链接。	下载审批附件	下载审批附件（历史版本）

审批任务

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
同意或拒绝审批任务	根据指定模板ID、实例ID、审批节点ID和审批人，对单个审批任务进行处理。	同意或拒绝审批任务	同意或拒绝审批任务（历史版本）
获取用户待审批数量	根据用户的userid获取该用户待处理的审批数量。	获取用户待审批数量	获取用户待审批数量（历史版本）
转交OA审批任务	转交OA审批任务。	转交OA审批任务	-

自有OA审批