文档中心 > API类目 > 钉钉API

dingtalk.smartwork.bpms.processinstance.create (发起审批实例)

企业或isv调用该api，来发起一个审批实例

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
agent_id	Number	可选	41605932		企业微应用标识
process_code	String	必须	PROC-EF6YJL35P2-SCKICSB7P750S0YISYKV3-17IBLGZI-1		审批流的唯一码
originator_user_id	String	必须	manager432		审批实例发起人的userid
dept_id	Number	必须	100		发起人所在的部门
approvers	String []	必须	zhangsan,lisi	最大列表长度：20	审批人userid列表
cc_list	String []	可选	zhangsan,lisi	最大列表长度：20	抄送人userid列表
cc_position	String	可选	START		抄送时间,分为（START,FINISH,START_FINISH）
form_component_values	FormComponentValueVo []	必须		最大列表长度：20	审批流表单参数
└ name String 必须请假类型表单每一栏的名称 └ value String 必须事假表单每一栏的值 └ ext_value String 可选总天数:1 扩展值

响应参数

名称	类型	示例值	描述
result	DingOpenResult		result
└ ding_open_errcode Number 0 dingOpenErrcode └ error_msg String ok errorMsg └ is_success Boolean true success └ process_instance_id String 12345 审批实例id

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
SmartworkBpmsProcessinstanceCreateRequest req = new SmartworkBpmsProcessinstanceCreateRequest();
req.setAgentId(41605932L);
req.setProcessCode("PROC-EF6YJL35P2-SCKICSB7P750S0YISYKV3-17IBLGZI-1");
req.setOriginatorUserId("manager432");
req.setDeptId(100L);
req.setApprovers("zhangsan,lisi");
req.setCcList("zhangsan,lisi");
req.setCcPosition("START");
List<FormComponentValueVo> list2 = new ArrayList<FormComponentValueVo>();
FormComponentValueVo obj3 = new FormComponentValueVo();
list2.add(obj3);
obj3.setName("请假类型");
obj3.setValue("事假");
obj3.setExtValue("总天数:1");
req.setFormComponentValues(list2);
SmartworkBpmsProcessinstanceCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
SmartworkBpmsProcessinstanceCreateRequest req = new SmartworkBpmsProcessinstanceCreateRequest();
req.AgentId = 41605932L;
req.ProcessCode = "PROC-EF6YJL35P2-SCKICSB7P750S0YISYKV3-17IBLGZI-1";
req.OriginatorUserId = "manager432";
req.DeptId = 100L;
req.Approvers = "zhangsan,lisi";
req.CcList = "zhangsan,lisi";
req.CcPosition = "START";
List<SmartworkBpmsProcessinstanceCreateRequest.FormComponentValueVoDomain> list2 = new List<SmartworkBpmsProcessinstanceCreateRequest.FormComponentValueVoDomain>();
SmartworkBpmsProcessinstanceCreateRequest.FormComponentValueVoDomain obj3 = new SmartworkBpmsProcessinstanceCreateRequest.FormComponentValueVoDomain();
list2.Add(obj3);
obj3.Name = "请假类型";
obj3.Value = "事假";
obj3.ExtValue = "总天数:1";
req.FormComponentValues_ = list2;
SmartworkBpmsProcessinstanceCreateResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_TOP, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new SmartworkBpmsProcessinstanceCreateRequest;
$req->setAgentId("41605932");
$req->setProcessCode("PROC-EF6YJL35P2-SCKICSB7P750S0YISYKV3-17IBLGZI-1");
$req->setOriginatorUserId("manager432");
$req->setDeptId("100");
$req->setApprovers("zhangsan,lisi");
$req->setCcList("zhangsan,lisi");
$req->setCcPosition("START");
$form_component_values = new FormComponentValueVo;
$form_component_values->name="请假类型";
$form_component_values->value="事假";
$form_component_values->ext_value="总天数:1";
$req->setFormComponentValues(array($form_component_values));
$resp = $c->execute($req, $access_token, "https://eco.taobao.com/router/rest");

curl -X POST "https://eco.taobao.com/router/rest" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'format=json' \
-d 'method=dingtalk.smartwork.bpms.processinstance.create' \
-d 'partner_id=apidoc' \
-d 'session=85a15bc4-0617-41f3-a29f-aa10451b39b6' \
-d 'timestamp=2025-05-09+20%3A59%3A36' \
-d 'v=2.0' \
-d 'agent_id=41605932' \
-d 'approvers=zhangsan%2Clisi' \
-d 'cc_list=zhangsan%2Clisi' \
-d 'cc_position=START' \
-d 'dept_id=100' \
-d 'form_component_values=null' \
-d 'originator_user_id=manager432' \
-d 'process_code=PROC-EF6YJL35P2-SCKICSB7P750S0YISYKV3-17IBLGZI-1'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.SmartworkBpmsProcessinstanceCreateRequest("https://eco.taobao.com/router/rest")

req.agent_id=41605932
req.process_code="PROC-EF6YJL35P2-SCKICSB7P750S0YISYKV3-17IBLGZI-1"
req.originator_user_id="manager432"
req.dept_id=100
req.approvers="zhangsan,lisi"
req.cc_list="zhangsan,lisi"
req.cc_position="START"
req.form_component_values=""
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.smartwork.bpms.processinstance.create");
add_param(pRequest,"agent_id","41605932");
add_param(pRequest,"process_code","PROC-EF6YJL35P2-SCKICSB7P750S0YISYKV3-17IBLGZI-1");
add_param(pRequest,"originator_user_id","manager432");
add_param(pRequest,"dept_id","100");
add_param(pRequest,"approvers","zhangsan,lisi");
add_param(pRequest,"cc_list","zhangsan,lisi");
add_param(pRequest,"cc_position","START");
add_param(pRequest,"form_component_values","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.smartwork.bpms.processinstance.create', {
	'agent_id':'41605932',
	'process_code':'PROC-EF6YJL35P2-SCKICSB7P750S0YISYKV3-17IBLGZI-1',
	'originator_user_id':'manager432',
	'dept_id':'100',
	'approvers':'zhangsan,lisi',
	'cc_list':'zhangsan,lisi',
	'cc_position':'START',
	'form_component_values':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<dingtalk_smartwork_bpms_processinstance_create_response>
    <result>
        <ding_open_errcode>0</ding_open_errcode>
        <error_msg>ok</error_msg>
        <is_success>true</is_success>
        <process_instance_id>12345</process_instance_id>
    </result>
</dingtalk_smartwork_bpms_processinstance_create_response>

{
    "dingtalk_smartwork_bpms_processinstance_create_response":{
        "result":{
            "ding_open_errcode":0,
            "error_msg":"ok",
            "is_success":true,
            "process_instance_id":"12345"
        }
    }
}

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.smartwork.bpms.processinstance.create (发起审批实例)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ