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

dingtalk.oapi.pbp.instance.create (打卡业务平台创建业务实例)

打卡业务平台，创建业务实例，根据业务实例可以配置打卡组（位置、人群、规则）

公共参数

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

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	描述
start_time	Number	可选	1576590152000	实例开始时间，时间戳
outer_id	String	必须	xxxxxx	外部id，唯一对应一次业务实例，如一次会议的meeting_id
biz_id	String	必须	m_checkin	业务id，接入时由系统分配
end_time	Number	可选	1576590152000	实例结束时间，时间戳
active	Boolean	可选	true	是否启用，建议传入该参数，只有启用状态的实例才允许打卡。如果不传入该参数，则实例默认为“已创建”状态而非“启用”状态。

响应参数

名称	类型	示例值	描述
errmsg	String	xxxx	错误信息
errcode	Number	empty outerId	错误码
biz_inst_id	String	xxxxxx	业务实例id

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/pbp/instance/create");
OapiPbpInstanceCreateRequest req = new OapiPbpInstanceCreateRequest();
req.setStartTime(1576590152000L);
req.setOuterId("xxxxxx");
req.setBizId("m_checkin");
req.setEndTime(1576590152000L);
req.setActive(true);
OapiPbpInstanceCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/pbp/instance/create");
OapiPbpInstanceCreateRequest req = new OapiPbpInstanceCreateRequest();
req.StartTime = 1576590152000L;
req.OuterId = "xxxxxx";
req.BizId = "m_checkin";
req.EndTime = 1576590152000L;
req.Active = true;
OapiPbpInstanceCreateResponse 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_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiPbpInstanceCreateRequest;
$req->setStartTime("1576590152000");
$req->setOuterId("xxxxxx");
$req->setBizId("m_checkin");
$req->setEndTime("1576590152000");
$req->setActive("true");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/pbp/instance/create");

curl -X POST "https://oapi.dingtalk.com/topapi/pbp/instance/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=69e70b03-c428-460a-b165-901205a417ab' \
-d 'active=true' \
-d 'biz_id=m_checkin' \
-d 'end_time=1576590152000' \
-d 'outer_id=xxxxxx' \
-d 'start_time=1576590152000'

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

req=dingtalk.api.OapiPbpInstanceCreateRequest("https://oapi.dingtalk.com/topapi/pbp/instance/create")

req.start_time=1576590152000
req.outer_id="xxxxxx"
req.biz_id="m_checkin"
req.end_time=1576590152000
req.active=true
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.oapi.pbp.instance.create");
add_param(pRequest,"start_time","1576590152000");
add_param(pRequest,"outer_id","xxxxxx");
add_param(pRequest,"biz_id","m_checkin");
add_param(pRequest,"end_time","1576590152000");
add_param(pRequest,"active","true");
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.oapi.pbp.instance.create', {
	'start_time':'1576590152000',
	'outer_id':'xxxxxx',
	'biz_id':'m_checkin',
	'end_time':'1576590152000',
	'active':'true'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errmsg":"xxxx",
    "errcode":empty outerId,
    "biz_inst_id":"xxxxxx"
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.pbp.instance.create (打卡业务平台创建业务实例)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ