Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
服务端API
  • 历史文档(不推荐)
  • 开发钉钉应用
  • 服务端API
  • 新版服务端API(DingTalk OpenAPI)
  • 生态伙伴API
获取凭证(access_token)身份验证(免登)应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理(官方CRM)培训智能硬件
获取凭证(access_token)身份验证(免登)应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理(官方CRM)培训智能硬件
  1. 官方工作流
  • 自有工作流
    • 创建或更新审批模板
      POST
    • 获取模板code
      POST
    • 删除模板
      POST
    • 清理工作流数据
      POST
    • 创建实例
      POST
    • 更新实例状态
      POST
    • 批量更新实例状态
      POST
    • 创建待办事项
      POST
    • 查询待办列表
      POST
    • 更新待办状态
      POST
    • 批量取消待办
      POST
  • 官方工作流
    • 发起审批实例
      POST
    • 获取审批实例详情
      POST
    • 添加审批评论
      POST
    • 撤销审批实例
      POST
    • 获取审批实例ID列表
      POST
    • 获取用户待审批数量
      POST
    • 获取指定用户可见的审批表单列表
      POST
    • 查询已设置为条件的表单组件
      POST
    • 获取当前企业所有可管理的模版
      POST
    • 获取审批钉盘空间信息
      POST
    • 授权预览审批附件
      POST
    • 授权下载审批钉盘文件
      POST
    • 下载审批附件
      POST
    • 同意或拒绝审批任务
      POST
  1. 官方工作流

发起审批实例

POST
http://127.0.0.1/topapi/processinstance/create
服务端API/智能工作流/官方工作流
最后修改时间:2022-08-30 09:19:22
责任人:未设置

说明#

调用本接口发起一个审批。
服务地址:https://oapi.dingtalk.com

权限#

服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。详情请参考权限申请。
应用类型是否支持调用权限申请方式API Explorer调试
企业内部应用是开发者后台申请调试
第三方企业应用是开发者后台申请调试
第三方个人应用否——

请求参数

Query 参数
access_token
string 
必需
调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。
示例值:
6d1bxxxx
Body 参数application/json
agent_id
number 
可选
应用标识。可在开发者后台的应用详情页获取。如果是第三方企业应用必须指定该参数。
process_code
string 
必需
审批流的唯一码。process_code在审批模板编辑页面的URL中获取。
originator_user_id
string 
必需
审批实例发起人的userid。
dept_id
number 
必需
发起人所在的部门,如果发起人属于根部门,传-1。
approvers
string 
可选
审批人userid列表,最大列表长度20。多个审批人用逗号分隔,按传入的顺序依次审批。
approvers_v2
array [object {2}] 
可选
审批人列表。支持会签/或签,优先级高于approvers变量。
task_action_type
string 
可选
审批类型:会签:AND或签:OR单人:NONE
user_ids
array[string]
可选
审批人userid列表:会签/或签列表长度必须大于1非会签/或签列表长度只能为1
cc_list
string 
可选
抄送人userid列表。该参数需要与approvers或approvers_v2参数一起传,抄送人才会生效。
cc_position
string 
可选
在什么节点抄送给抄送人:STARTFINISHSTART_FINISH
form_component_values
array [object {3}] 
必需
审批流表单参数,最大列表长度20。仅支持下表列举的表单控件。
name
string 
表单每一栏的名称。
必需
value
string 
表单每一栏的值。
必需
ext_value
string 
扩展值。
可选
示例
{
    "form_component_values": [
        {
            "name": "单行输入框",
            "value": "测试单行输入框"
        },
        {
            "name": "多行输入框",
            "value": "测试多行输入框"
        },
        {
            "name": "金额(元)大写",
            "value": "1"
        },
        {
            "name": "数字输入框",
            "value": "100"
        },
        {
            "name": "单选框",
            "value": "a"
        },
        {
            "name": "多选框",
            "value": "[\"a\",\"b\"]"
        }, 
        {
            "name": "日期",
            "value": "2021-08-17"
        },
        {
            "name": "[\"开始时间\",\"结束时间\"]",
            "value": "[\"2019-02-19\",\"2019-02-25\"]"
        },
        {
            "name": "图片",
            "value": ["http://url1","http://url2","http://url3"]
        },
        {
            "name": "附件",
            "value": [{"spaceId": "163xxxx658", "fileName": "2644.JPG", "fileSize": "333", "fileType": "jpg", "fileId": "643xxxx140"}]
        },
        {
            "name": "联系人",
            "value": "[\"4525xxxxxxxx77041\"]"
        },
        {
            "name":"关联审批单",
            "value":[
                "fa2aa864-xxxx-xxxx-xxxx-75572c0e2cdf",
                "7125778e-xxxx-xxxx-xxxx-faa987478a9b"
                
            ]
        },
        {
            "name": "明细",
            "value": [
                [
                    {
                        "name":"单行输入框",
                        "value":"明细单行输入框"
                    },
                    {
                        "name":"数字输入框",
                        "value":"100"
                    }
                    
                ]
            ]
        }
        
        
    ],
    "agent_id": 115xxxx211,
    "process_code": "PROC-37801FB3-xxxx-xxxx-xxxx-6C6ADB87CD9A",
    "cc_position": "FINISH",
    // "approvers": "4525xxxxxxxx77041,2643xxxxxxx69379",
    "cc_list": "4525xxxxxxxx77041",
    "dept_id": 70041378,
    "approvers_v2": [      //设置审批人,会签、或签设置的审批人必须大于等于2个人
         {
            "task_action_type": "AND",
            "user_ids": [
                "4525xxxxxxxx77041",
                "2643xxxxxxx69379"
            ]
        },
        {
            "task_action_type": "OR",
            "user_ids": [
                "4525xxxxxxxx77041",
                "2643xxxxxxx69379"
            ]
        }
       
    ],
    "originator_user_id": "4525xxxxxxxx77041"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/topapi/processinstance/create?access_token=6d1bxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "form_component_values": [
        {
            "name": "单行输入框",
            "value": "测试单行输入框"
        },
        {
            "name": "多行输入框",
            "value": "测试多行输入框"
        },
        {
            "name": "金额(元)大写",
            "value": "1"
        },
        {
            "name": "数字输入框",
            "value": "100"
        },
        {
            "name": "单选框",
            "value": "a"
        },
        {
            "name": "多选框",
            "value": "[\"a\",\"b\"]"
        }, 
        {
            "name": "日期",
            "value": "2021-08-17"
        },
        {
            "name": "[\"开始时间\",\"结束时间\"]",
            "value": "[\"2019-02-19\",\"2019-02-25\"]"
        },
        {
            "name": "图片",
            "value": ["http://url1","http://url2","http://url3"]
        },
        {
            "name": "附件",
            "value": [{"spaceId": "163xxxx658", "fileName": "2644.JPG", "fileSize": "333", "fileType": "jpg", "fileId": "643xxxx140"}]
        },
        {
            "name": "联系人",
            "value": "[\"4525xxxxxxxx77041\"]"
        },
        {
            "name":"关联审批单",
            "value":[
                "fa2aa864-xxxx-xxxx-xxxx-75572c0e2cdf",
                "7125778e-xxxx-xxxx-xxxx-faa987478a9b"
                
            ]
        },
        {
            "name": "明细",
            "value": [
                [
                    {
                        "name":"单行输入框",
                        "value":"明细单行输入框"
                    },
                    {
                        "name":"数字输入框",
                        "value":"100"
                    }
                    
                ]
            ]
        }
        
        
    ],
    "agent_id": 115xxxx211,
    "process_code": "PROC-37801FB3-xxxx-xxxx-xxxx-6C6ADB87CD9A",
    "cc_position": "FINISH",
    // "approvers": "4525xxxxxxxx77041,2643xxxxxxx69379",
    "cc_list": "4525xxxxxxxx77041",
    "dept_id": 70041378,
    "approvers_v2": [      //设置审批人,会签、或签设置的审批人必须大于等于2个人
         {
            "task_action_type": "AND",
            "user_ids": [
                "4525xxxxxxxx77041",
                "2643xxxxxxx69379"
            ]
        },
        {
            "task_action_type": "OR",
            "user_ids": [
                "4525xxxxxxxx77041",
                "2643xxxxxxx69379"
            ]
        }
       
    ],
    "originator_user_id": "4525xxxxxxxx77041"
}'

返回响应

🟢200成功
application/json
Body
errcode
number 
返回码。
可选
errmsg
string 
返回码描述。
可选
request_id
string 
请求ID。
可选
process_instance_id
string 
审批实例ID。
可选
示例
{
  "errcode": 0,
  "errmsg": "string",
  "request_id": "string",
  "process_instance_id": "string"
}
上一页
批量取消待办
下一页
获取审批实例详情
Built with