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

dingtalk.oapi.attendance.shift.add (创建/修改班次)

创建/修改钉钉考勤班次

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	描述
op_user_id	String	必须	abc	操作人
shift	TopAtClassVo	必须		班次
└ owner String 可选 abc 班次owner └ class_group_name String 可选 def 班次组名 └ corp_id String 可选 ding23 corpId └ name String 必须白班班次名称 └ id Number 可选 124 班次id sections TopAtSectionVo [] 必须 sections times TopAtTimeVo [] 必须 times └ check_type String 必须 OnDuty 类型(OnDuty上班，OffDuty下班) └ across Number 必须 0 是否跨天 └ end_min Number 可选 -1 允许的最玩打卡时间，分钟为单位（-1表示不限制） └ check_time Date 必须 2020-03-17 12:00:00 check时间 └ free_check Boolean 可选 false 是否免打卡 └ begin_min Number 可选 30 允许的最早提前打卡时间，分钟为单位 └ flex_minutes Number [] 可选 [60,60] 当前卡点允许弹性调整范围 setting TopAtClassSettingVo 可选设置 rest_begin_time TopAtTimeVo 可选休息开始 └ check_type String 可选 OnDuty 类型 └ check_time Date 可选 2020-03-17 12:00:00 check时间 └ free_check Boolean 可选 false 是否免打卡 └ across Number 可选 0 是否跨天 └ class_id Number 可选 221 班次id └ is_flexible Boolean 可选 false 是否弹性 └ corp_id String 可选 ding121 corpId └ is_deleted String 可选 N 是否删除 rest_end_time TopAtTimeVo 可选休息结束 └ check_type String 可选 OffDuty 类型 └ check_time Date 可选 2020-03-17 13:00:00 check时间 └ free_check Boolean 可选 false 是否免打卡 └ across Number 可选 1 是否跨天 └ serious_late_minutes Number 可选 31 严重迟到分钟数 └ absenteeism_late_minutes Number 可选 60 旷工迟到分钟数 └ extras 可选 {"cause":"{\"type\":\"approve\",\"relatedId\":\"43494469-21a6-4111-953b-7810a709f27f\"}"} 班次设置扩展字段（非临时班次无需填写） └ tags String 可选 temp:schedule:isv 班次tags（非临时班次无需填写） └ demand_work_time_minutes Number 可选 480 固定时长弹性班次设置的工作时长 └ attend_days String 可选 0.5 该班次对应的出勤天数 rest_time_list TopAtTimeVo [] 可选班次休息时段列表，[start1,end1,start2,end2]格式，最多支持3段 └ across Number 可选 1 是否跨天 └ free_check Boolean 可选 false 是否免打卡 └ check_time Date 可选 2020-03-17 13:00:00 休息时段开始结束时间点 └ check_type String 可选 OnDuty 类型 └ service_id Number 可选 123 高级排班绑定服务id（非临时班次无需填写）

响应参数

名称	类型	描述
result	TopAtClassVo	班次信息
└ id Number 班次id └ name String 班次名称
errmsg	String	错误信息
errcode	Number	错误码
success	Boolean	是否成功

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/attendance/shift/add");
OapiAttendanceShiftAddRequest req = new OapiAttendanceShiftAddRequest();
req.setOpUserId("abc");
TopAtClassVo obj1 = new TopAtClassVo();
obj1.setOwner("abc");
obj1.setClassGroupName("def");
obj1.setCorpId("ding23");
obj1.setName("白班");
obj1.setId(124L);
List<TopAtSectionVo> list3 = new ArrayList<TopAtSectionVo>();
TopAtSectionVo obj4 = new TopAtSectionVo();
list3.add(obj4);
List<TopAtTimeVo> list7 = new ArrayList<TopAtTimeVo>();
TopAtTimeVo obj8 = new TopAtTimeVo();
list7.add(obj8);
obj8.setCheckType("OnDuty");
obj8.setAcross(0L);
obj8.setEndMin(-1L);
obj8.setCheckTime(StringUtils.parseDateTime("2020-03-17 12:00:00"));
obj8.setFreeCheck(false);
obj8.setBeginMin(30L);
obj8.setFlexMinutes(new Long[] { 60,60 };
);
list5.setTimes(list7);
obj1.setSections(list3);
TopAtClassSettingVo obj9 = new TopAtClassSettingVo();
TopAtTimeVo obj10 = new TopAtTimeVo();
obj10.setCheckType("OnDuty");
obj10.setCheckTime(StringUtils.parseDateTime("2020-03-17 12:00:00"));
obj10.setFreeCheck(false);
obj10.setAcross(0L);
obj9.setRestBeginTime(obj10);
obj9.setClassId(221L);
obj9.setIsFlexible(false);
obj9.setCorpId("ding121");
obj9.setIsDeleted("N");
TopAtTimeVo obj11 = new TopAtTimeVo();
obj11.setCheckType("OffDuty");
obj11.setCheckTime(StringUtils.parseDateTime("2020-03-17 13:00:00"));
obj11.setFreeCheck(false);
obj11.setAcross(1L);
obj9.setRestEndTime(obj11);
obj9.setSeriousLateMinutes(31L);
obj9.setAbsenteeismLateMinutes(60L);
obj9.setTags("temp:schedule:isv");
obj9.setDemandWorkTimeMinutes(480L);
obj9.setAttendDays("0.5");
List<TopAtTimeVo> list13 = new ArrayList<TopAtTimeVo>();
TopAtTimeVo obj14 = new TopAtTimeVo();
list13.add(obj14);
obj14.setAcross(1L);
obj14.setFreeCheck(false);
obj14.setCheckTime(StringUtils.parseDateTime("2020-03-17 13:00:00"));
obj14.setCheckType("OnDuty");
obj9.setRestTimeList(list13);
obj1.setSetting(obj9);
obj1.setServiceId(123L);
req.setShift(obj1);
OapiAttendanceShiftAddResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/attendance/shift/add");
OapiAttendanceShiftAddRequest req = new OapiAttendanceShiftAddRequest();
req.OpUserId = "abc";
OapiAttendanceShiftAddRequest.TopAtClassVoDomain obj1 = new OapiAttendanceShiftAddRequest.TopAtClassVoDomain();
obj1.Owner = "abc";
obj1.ClassGroupName = "def";
obj1.CorpId = "ding23";
obj1.Name = "白班";
obj1.Id = 124L;
List<OapiAttendanceShiftAddRequest.TopAtSectionVoDomain> list3 = new List<OapiAttendanceShiftAddRequest.TopAtSectionVoDomain>();
OapiAttendanceShiftAddRequest.TopAtSectionVoDomain obj4 = new OapiAttendanceShiftAddRequest.TopAtSectionVoDomain();
list3.Add(obj4);
List<OapiAttendanceShiftAddRequest.TopAtTimeVoDomain> list6 = new List<OapiAttendanceShiftAddRequest.TopAtTimeVoDomain>();
OapiAttendanceShiftAddRequest.TopAtTimeVoDomain obj7 = new OapiAttendanceShiftAddRequest.TopAtTimeVoDomain();
list6.Add(obj7);
obj7.CheckType = "OnDuty";
obj7.Across = 0L;
obj7.EndMin = -1L;
obj7.CheckTime = DateTime.Parse(2020-03-17 12:00:00");
obj7.FreeCheck = false;
obj7.BeginMin = 30L;
obj7.FlexMinutes = new long[] { 60,60 };
;
obj4.Times= list6;
obj1.Sections= list3;
OapiAttendanceShiftAddRequest.TopAtClassSettingVoDomain obj8 = new OapiAttendanceShiftAddRequest.TopAtClassSettingVoDomain();
OapiAttendanceShiftAddRequest.TopAtTimeVoDomain obj9 = new OapiAttendanceShiftAddRequest.TopAtTimeVoDomain();
obj9.CheckType = "OnDuty";
obj9.CheckTime = DateTime.Parse(2020-03-17 12:00:00");
obj9.FreeCheck = false;
obj9.Across = 0L;
obj8.RestBeginTime= obj9;
obj8.ClassId = 221L;
obj8.IsFlexible = false;
obj8.CorpId = "ding121";
obj8.IsDeleted = "N";
OapiAttendanceShiftAddRequest.TopAtTimeVoDomain obj10 = new OapiAttendanceShiftAddRequest.TopAtTimeVoDomain();
obj10.CheckType = "OffDuty";
obj10.CheckTime = DateTime.Parse(2020-03-17 13:00:00");
obj10.FreeCheck = false;
obj10.Across = 1L;
obj8.RestEndTime= obj10;
obj8.SeriousLateMinutes = 31L;
obj8.AbsenteeismLateMinutes = 60L;
obj8.Tags = "temp:schedule:isv";
obj8.DemandWorkTimeMinutes = 480L;
obj8.AttendDays = "0.5";
List<OapiAttendanceShiftAddRequest.TopAtTimeVoDomain> list12 = new List<OapiAttendanceShiftAddRequest.TopAtTimeVoDomain>();
OapiAttendanceShiftAddRequest.TopAtTimeVoDomain obj13 = new OapiAttendanceShiftAddRequest.TopAtTimeVoDomain();
list12.Add(obj13);
obj13.Across = 1L;
obj13.FreeCheck = false;
obj13.CheckTime = DateTime.Parse(2020-03-17 13:00:00");
obj13.CheckType = "OnDuty";
obj8.RestTimeList= list12;
obj1.Setting= obj8;
obj1.ServiceId = 123L;
req.Shift_ = obj1;
OapiAttendanceShiftAddResponse 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 OapiAttendanceShiftAddRequest;
$req->setOpUserId("abc");
$shift = new TopAtClassVo;
$shift->owner="abc";
$shift->class_group_name="def";
$shift->corp_id="ding23";
$shift->name="白班";
$shift->id="124";
$sections = new TopAtSectionVo;
$times = new TopAtTimeVo;
$times->check_type="OnDuty";
$times->across="0";
$times->end_min="-1";
$times->check_time="2020-03-17 12:00:00";
$times->free_check="false";
$times->begin_min="30";
$times->flex_minutes="[60,60]";
$sections->times = array($times);
$shift->sections = array($sections);
$setting = new TopAtClassSettingVo;
$rest_begin_time = new TopAtTimeVo;
$rest_begin_time->check_type="OnDuty";
$rest_begin_time->check_time="2020-03-17 12:00:00";
$rest_begin_time->free_check="false";
$rest_begin_time->across="0";
$setting->rest_begin_time = $rest_begin_time;
$setting->class_id="221";
$setting->is_flexible="false";
$setting->corp_id="ding121";
$setting->is_deleted="N";
$rest_end_time = new TopAtTimeVo;
$rest_end_time->check_type="OffDuty";
$rest_end_time->check_time="2020-03-17 13:00:00";
$rest_end_time->free_check="false";
$rest_end_time->across="1";
$setting->rest_end_time = $rest_end_time;
$setting->serious_late_minutes="31";
$setting->absenteeism_late_minutes="60";
$setting->tags="temp:schedule:isv";
$setting->demand_work_time_minutes="480";
$setting->attend_days="0.5";
$rest_time_list = new TopAtTimeVo;
$rest_time_list->across="1";
$rest_time_list->free_check="false";
$rest_time_list->check_time="2020-03-17 13:00:00";
$rest_time_list->check_type="OnDuty";
$setting->rest_time_list = array($rest_time_list);
$shift->setting = $setting;
$shift->service_id="123";
$req->setShift($shift);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/attendance/shift/add");

curl -X POST "https://oapi.dingtalk.com/topapi/attendance/shift/add" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=a97ce09b-d17b-4b49-af9b-ebeb42745f23' \
-d 'op_user_id=abc' \
-d 'shift=null'

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

req=dingtalk.api.OapiAttendanceShiftAddRequest("https://oapi.dingtalk.com/topapi/attendance/shift/add")

req.op_user_id="abc"
req.shift=""
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.attendance.shift.add");
add_param(pRequest,"op_user_id","abc");
add_param(pRequest,"shift","数据结构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.oapi.attendance.shift.add', {
	'op_user_id':'abc',
	'shift':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "id":,
        "name":""
    },
    "errmsg":"",
    "errcode":,
    "success":
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.attendance.shift.add (创建/修改班次)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ