企业内部开发 服务端API OA 打卡 获取企业所有打卡规则
获取企业所有打卡规则

企业可通过打卡应用Secret调用本接口,获取企业内所有打卡规则数据。

请求方式:POST(HTTPS
请求地址:https://qyapi.weixin.qq.com/cgi-bin/checkin/getcorpcheckinoption?access_token=ACCESS_TOKEN

请求示例:

{}

参数说明:

参数必须说明
access_token调用接口凭证。必须使用打卡应用的Secret获取access_token,获取方式参考:文档-获取access_token

调用频率:
接口调用频率限制为60次/分钟。

返回结果 :

{
	"errcode": 0,
	"errmsg": "ok",
	"group": [{
		"grouptype": 1,
		"groupid": 69,
		"checkindate": [{
			"workdays": [
				1,
				2,
				3,
				4,
				5
			],
			"checkintime": [{
					"work_sec": 36000,
					"off_work_sec": 43200,
					"remind_work_sec": 35400,
					"remind_off_work_sec": 43200
				},
				{
					"work_sec": 50400,
					"off_work_sec": 72000,
					"remind_work_sec": 49800,
					"remind_off_work_sec": 72000
				}
			],
			"noneed_offwork": true,
			"limit_aheadtime": 10800000,
			"flex_on_duty_time": 0,
			"flex_off_duty_time": 0,
		}],
		"spe_workdays": [{
			"timestamp": 1512144000,
			"notes": "必须打卡的日期",
			"checkintime": [{
				"work_sec": 32400,
				"off_work_sec": 61200,
				"remind_work_sec": 31800,
				"remind_off_work_sec": 61200
			}]
		}],
		"spe_offdays": [{
			"timestamp": 1512057600,
			"notes": "不需要打卡的日期",
			"checkintime": []
		}],
		"sync_holidays": true,
		"groupname": "打卡规则1",
		"need_photo": true,
		"wifimac_infos": [{
				"wifiname": "Tencent-WiFi-1",
				"wifimac": "c0:7b:bc:37:f8:d3",
			},
			{
				"wifiname": "Tencent-WiFi-2",
				"wifimac": "70:10:5c:7d:f6:d5",
			}
		],
		"note_can_use_local_pic": false,
		"allow_checkin_offworkday": true,
		"allow_apply_offworkday": true,
		"loc_infos": [{
				"lat": 30547030,
				"lng": 104062890,
				"loc_title": "腾讯成都大厦",
				"loc_detail": "四川省成都市武侯区高新南区天府三街",
				"distance": 300
			},
			{
				"lat": 23097490,
				"lng": 113323750,
				"loc_title": "T.I.T创意园",
				"loc_detail": "广东省广州市海珠区新港中路397号",
				"distance": 300
			}
		],
		"range": {
			"partyid": []
			"userid": ["icef", "LiJingZhong"]
			"tagid": [2]
		},
		"create_time": 1606204343,
		"white_users": ["canno"],
		"type": 0,
		"reporterinfo": {
			"reporters": [{
				"userid": "brant"
			}],
			"updatetime": 1606305508
		},
		"ot_info": {
			"type": 2,
			"allow_ot_workingday": true,
			"allow_ot_nonworkingday": false,
			"otcheckinfo": {
				"ot_workingday_time_start": 1800,
				"ot_workingday_time_min": 1800,
				"ot_workingday_time_max": 14400,
				"ot_nonworkingday_time_min": 1800,
				"ot_nonworkingday_time_max": 14400,
				"ot_workingday_restinfo": {
					"type": 2,
					"fix_time_rule": {
						"fix_time_begin_sec": 43200,
						"fix_time_end_sec": 46800
					},
					"cal_ottime_rule": {
						"items": [{
							"ot_time": 18000,
							"rest_time": 3600
						}]
					}
				},
				"ot_nonworkingday_restinfo": {
					"type": 2,
					"fix_time_rule": {
						"fix_time_begin_sec": 43200,
						"fix_time_end_sec": 46800
					},
					"cal_ottime_rule": {
						"items": [{
							"ot_time": 18000,
							"rest_time": 3600
						}]
					}
				},
				"ot_nonworkingday_spanday_time": 0
			},
			"uptime": 1606275664,
			"otapplyinfo": {
				"allow_ot_workingday": true "allow_ot_nonworkingday": true "uptime": 1606275664,
				"ot_workingday_restinfo": {
					"type": 2,
					"fix_time_rule": {
						"fix_time_begin_sec": 43200,
						"fix_time_end_sec": 46800
					},
					"cal_ottime_rule": {
						"items": [{
							"ot_time": 18000,
							"rest_time": 3600
						}]
					}
				},
				"ot_nonworkingday_restinfo": {
					"type": 2,
					"fix_time_rule": {
						"fix_time_begin_sec": 43200,
						"fix_time_end_sec": 46800
					},
					"cal_ottime_rule": {
						"items": [{
							"ot_time": 18000,
							"rest_time": 3600
						}]
					}
				},
				"ot_nonworkingday_spanday_time": 0
			}
		},
		"allow_apply_bk_cnt": -1,
		"option_out_range": 0,
		"create_userid": "gaogao",
		"use_face_detect": false,
		"allow_apply_bk_day_limit": -1,
		"update_userid": "sandy",
		"schedulelist": [{
			"schedule_id": 221,
			"schedule_name": "2",
			"time_section": [{
				"time_id": 1,
				"work_sec": 32400,
				"off_work_sec": 61200,
				"remind_work_sec": 31800,
				"remind_off_work_sec": 61200,
				"rest_begin_time": 43200,
				"rest_end_time": 46800,
				"allow_rest": false
			}],
			"limit_aheadtime": 14400000,
			"noneed_offwork": false,
			"limit_offtime": 14400,
			"flex_on_duty_time": 0,
			"flex_off_duty_time": 0,
			"allow_flex": false,
			"late_rule": {
				"allow_offwork_after_time": false,
				"timerules": [{
					"offwork_after_time": 3600,
					"onwork_flex_time": 3600
				}]
			},
			"max_allow_arrive_early": 0,
			"max_allow_arrive_late": 0
		}],
		"offwork_interval_time": 300
	}]
}

参数说明:

参数类型说明
errcodeint32错误码,详情见错误码说明
errmsgstring错误码对应的错误信息提示
groupobj[]企业规则信息列表
group.grouptypeuint32打卡规则类型,1:固定时间上下班;2:按班次上下班;3:自由上下班
group.groupiduint32打卡规则id
group.groupnamestring打卡规则名称
group.checkindateobj[]打卡时间,当规则类型为排班时没有意义
group.checkindate.workdaysuint32[]工作日。若为固定时间上下班或自由上下班,则1到6分别表示星期一到星期六,0表示星期日
group.checkindate.checkintimeuint32工作日上下班打卡时间信息
group.checkindate.checkintime.work_secuint32上班时间,表示为距离当天0点的秒数。
group.checkindate.checkintime.off_work_secuint32下班时间,表示为距离当天0点的秒数。
group.checkindate.checkintime.remind_work_secuint32上班提醒时间,表示为距离当天0点的秒数。
group.checkindate.checkintime.remind_off_work_secuint32下班提醒时间,表示为距离当天0点的秒数。
group.checkindate.noneed_offworkbool下班不需要打卡,true为下班不需要打卡,false为下班需要打卡
group.checkindate.limit_aheadtimeuint32打卡时间限制(毫秒)
group.checkindate.flex_on_duty_timeint32允许迟到时间,单位ms
group.checkindate.flex_off_duty_timeint32允许早退时间,单位ms
group.spe_workdaysobj[]特殊日期-必须打卡日期信息,timestamp表示具体时间
group.spe_workdays.timestampuint32特殊日期-必须打卡日期时间戳
group.spe_workdays.notesstring特殊日期备注
group.spe_workdays.checkintimeobj[]特殊日期-必须打卡日期-上下班打卡时间,内部参数同group.checkindate.checkintime
group.spe_offdaysobj[]特殊日期-不用打卡日期信息, timestamp表示具体时间
group.spe_offdays.timestampuint32特殊日期-不用打卡日期时间戳
group.spe_offdays.notesstring特殊日期备注
group.sync_holidaysbool是否同步法定节假日,true为同步,false为不同步,当前排班不支持
group.need_photobool是否打卡必须拍照,true为必须拍照,false为不必须拍照
group.note_can_use_local_picbool是否备注时允许上传本地图片,true为允许,false为不允许
group.allow_checkin_offworkdaybool是否非工作日允许打卡,true为允许,false为不允许
group.allow_apply_offworkdaybool是否允许提交补卡申请,true为允许,false为不允许
group.wifimac_infosobj[]打卡地点-WiFi打卡信息
group.wifimac_infos.wifinamestringWiFi打卡地点名称
group.wifimac_infos.wifimacstringWiFi打卡地点MAC地址/bssid
group.loc_infosobj[]打卡地点-位置打卡信息
group.loc_infos.latint64位置打卡地点纬度,是实际纬度的1000000倍,与腾讯地图一致采用GCJ-02坐标系统标准
group.loc_infos.lngint64位置打卡地点经度,是实际经度的1000000倍,与腾讯地图一致采用GCJ-02坐标系统标准
group.loc_infos.loc_titlestring位置打卡地点名称
group.loc_infos.loc_detailstring位置打卡地点详情
group.loc_infos.distanceuint32允许打卡范围(米)
group.rangeobj打卡人员信息
group.range.useridstring打卡人员中,单个打卡人员节点的userid
group.range.partyidstring[]打卡人员中,部门节点的id
group.range.tagiduint32[]打卡人员中,标签节点的标签id
group.create_timeuint32创建打卡规则时间,为unix时间戳
group.white_usersstring[]打卡人员白名单,即不需要打卡人员,需要有设置白名单才能查看
group.typeuint32打卡方式,0:手机;2:智慧考勤机;3:手机+智慧考勤机
group.reporterinfoobj汇报对象信息
group.reporterinfo.reportersobj[]汇报对象,每个汇报人用userid表示
group.reporterinfo.updatetimeuint32汇报对象更新时间
group.ot_infoobj加班信息,相关信息需要设置后才能显示
group.ot_info.typeint32加班类型 0:以加班申请核算打卡记录(根据打卡记录和加班申请核算),1:以打卡时间为准(根据打卡时间计算),2: 以加班申请审批为准(只根据加班申请计算)
group.ot_info.allow_ot_workingdaybool允许工作日加班,true为允许,false为不允许
group.ot_info.allow_ot_nonworkingdaybool允许非工作日加班,true为允许,flase为不允许
group.ot_info.otcheckinfoobj以打卡时间为准-加班时长计算规则信息
group.ot_info.otcheckinfo.ot_workingday_time_startuint32允许工作日加班-加班开始时间:下班后xx秒开始计算加班,距离最晚下班时间的秒数,例如,1800(30分钟 乘以 60秒),默认值30分钟
group.ot_info.otcheckinfo.ot_workingday_time_minuint32允许工作日加班-最短加班时长:不足xx秒视为未加班,单位秒,默认值30分钟
group.ot_info.otcheckinfo.ot_workingday_time_maxuint32允许工作日加班-最长加班时长:超过则视为加班xx秒,单位秒,默认值240分钟
group.ot_info.otcheckinfo.ot_nonworkingday_time_minuint32允许非工作日加班-最短加班时长:不足xx秒视为未加班,单位秒,默认值30分钟
group.ot_info.otcheckinfo.ot_nonworkingday_time_maxuint32允许非工作日加班-最长加班时长:超过则视为加班xx秒 单位秒,默认值240分钟
group.ot_info.otcheckinfo.ot_nonworkingday_spanday_timeuint32非工作日加班,跨天时间,距离当天00:00的秒数
group.ot_info.otcheckinfo.ot_workingday_restinfoobj工作日加班-休息扣除配置信息
uptimeuint32更新时间 |
group.ot_info.otcheckinfo.ot_workingday_restinfo.typeuint32工作日加班-休息扣除类型:0-不开启扣除;1-指定休息时间扣除;2-按加班时长扣除休息时间
group.ot_info.otcheckinfo.ot_workingday_restinfo.fix_time_ruleobj工作日加班-指定休息时间配置信息,当group.ot_info.otcheckinfo.ot_workingday_restinfo.type为1时有意义
group.ot_info.otcheckinfo.ot_workingday_restinfo.fix_time_rule.fix_time_begin_secuint32工作日加班-指定休息时间的开始时间, 距离当天00:00的秒数
group.ot_info.otcheckinfo.ot_workingday_restinfo.fix_time_rule.fix_time_end_secuint32工作日加班-指定休息时间的结束时间, 距离当天00:00的秒数
group.ot_info.otcheckinfo.ot_workingday_restinfo.cal_ottime_ruleobj工作日加班-按加班时长扣除配置信息,当group.ot_info.otcheckinfo.ot_workingday_restinfo.type为2时有意义
group.ot_info.otcheckinfo.ot_workingday_restinfo.cal_ottime_rule.itemsobj工作日加班-按加班时长扣除条件信息
group.ot_info.otcheckinfo.ot_workingday_restinfo.cal_ottime_rule.items.ot_timeuint32加班满-时长(秒)
group.ot_info.otcheckinfo.ot_workingday_restinfo.cal_ottime_rule.items.rest_timeuint32对应扣除-时长(秒)
group.ot_info.otcheckinfo.ot_nonworkingday_restinfoobj非工作日加班-休息扣除配置信息,参数信息与group.ot_info.otcheckinfo.ot_workingday_restinfo一致
otapplyinfoobj以加班申请核算打卡记录相关信息,根据加班申请核算加班时长,只有有设置相关信息时且以以加班申请核算打卡才有相关信息;内含参数释义基本同group.ot_info.otcheckinfo,但只包含加班休息扣除、跨天时间等参数
group.allow_apply_bk_cntint32每月最多补卡次数,默认-1表示不限制
group.option_out_rangeuint32范围外打卡处理方式,0-视为范围外异常,默认值;1-视为正常外勤;2:不允许范围外打卡
group.create_useridstring规则创建人userid
group.use_face_detectbool人脸识别打卡开关,true为启用,false为不启用
group.allow_apply_bk_day_limitint32允许补卡时限,默认-1表示不限制。单位天
group.update_useridstring规则最近编辑人userid
group.schedulelistobj[]排班信息,只有规则为按班次上下班打卡时才有该配置
group.schedulelist.schedule_iduint32班次id
group.schedulelist.schedule_namestring班次名称
group.schedulelist.time_sectionobj[]班次上下班时段信息
group.schedulelist.time_section.time_iduint32时段id,为班次中某一堆上下班时间组合的id
group.schedulelist.time_section.work_secuint32上班时间,表示为距离当天0点的秒数。
group.schedulelist.time_section.off_work_secuint32下班时间,表示为距离当天0点的秒数。
group.schedulelist.time_section.remind_work_secuint32上班提醒时间,表示为距离当天0点的秒数。
group.schedulelist.time_section.remind_off_work_secuint32下班提醒时间,表示为距离当天0点的秒数。
group.schedulelist.time_section.rest_begin_timeuint32休息开始时间,仅单时段支持,距离0点的秒
group.schedulelist.time_section.rest_end_timeuint32休息结束时间,仅单时段支持,距离0点的秒
group.schedulelist.time_section.allow_restbool是否允许休息
group.schedulelist.limit_aheadtimeuint32允许提前打卡时间
group.schedulelist.limit_offtimeuint32下班xx秒后不允许打下班卡
group.schedulelist.noneed_offworkbool下班不需要打卡
group.schedulelist.allow_flexbool是否允许弹性时间
group.schedulelist.flex_on_duty_timeuint32允许迟到时间
group.schedulelist.flex_off_duty_timeuint32允许早退时间
group.schedulelist.late_ruleobj晚走晚到时间规则信息
group.schedulelist.late_rule.allow_offwork_after_timebool是否允许超时下班(下班晚走次日晚到)允许时onwork_flex_time,offwork_after_time才有意义
group.schedulelist.late_rule.timerulesobj[]迟到规则时间
group.schedulelist.late_rule.timerules.offwork_after_timeuint32晚走的时间 距离最晚一个下班的时间单位:秒
group.schedulelist.late_rule.timerules.onwork_flex_timeuint32第二天第一个班次允许迟到的弹性时间单位:秒
group.schedulelist.max_allow_arrive_earlyuint32最早可打卡时间限制
group.schedulelist.max_allow_arrive_lateuint32最晚可打卡时间限制,max_allow_arrive_early、max_allow_arrive_early与flex_on_duty_time、flex_off_duty_time互斥,当设置其中一组时,另一组数值置0
group.offwork_interval_timeuint32自由签到,上班打卡后xx秒可打下班卡

 

上一篇
获取高清语音素材
下一篇
获取员工打卡规则