开发者中心
首页
教程
接口
社区
工具
企业内部开发
快速入门 服务端API 客户端API 附录 更新日志 联系我们
企业内部开发 服务端API 打卡 获取员工打卡规则
调试工具
获取员工打卡规则
最后更新：2023/12/18
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
获取员工打卡规则
最后更新：2023/12/18

自建应用、第三方应用和代开发应用可使用此接口，获取可见范围内指定员工指定日期的打卡规则。

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

请求示例：

{
    "datetime": 1511971200,
    "useridlist": ["james","paul"]
}

参数说明：

参数必须说明
access_token是调用接口凭证。获取方式参考：文档-获取access_token
须为有打卡权限的自建应用、第三方应用或代开发应用
datetime是需要获取规则的日期当天0点的Unix时间戳
useridlist是需要获取打卡规则的用户列表
1. 用户列表不超过100个，若用户超过100个，请分批获取。
2. 用户在不同日期的规则不一定相同，请按天获取。

 

权限说明:
调用的应用需要满足如下的权限：

应用类型权限要求
自建应用配置到「打卡 - 可调用接口的应用」中
代开发应用具有「打卡」权限
第三方应用具有「打卡」权限

注： 从2023年12月1日0点起，不再支持通过系统应用secret调用接口，存量企业暂不受影响 查看详情

 

返回结果 ：

{
    "errcode": 0,
    "errmsg": "ok",
    "info": [
        {
            "userid": "james",
            "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
                            }
                        ],
                        "flex_time": 300000,
                        "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
                    }
                ],
                "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
                        }
                 ]
            }
        }
    ]
}

参数说明：

参数类型说明
errcodeint32错误码，详情见错误码说明
errmsgstring错误码对应的错误信息提示
infoobj[]返回的打卡规则列表
useridstring打卡人员userid
groupobj打卡规则相关信息
group.grouptypeuint32打卡规则类型。1：固定时间上下班；2：按班次上下班；3：自由上下班 。
group.groupnamestring打卡规则名称
groupiduint32打卡规则id
group.checkindateobj[]打卡时间配置
group.checkindate.workdaysuint32[]工作日。若为固定时间上下班或自由上下班，则1到6分别表示星期一到星期六，0表示星期日；若为按班次上下班，则表示拉取班次的日期。
group.checkindate.checkintimeobj[]工作日上下班打卡时间信息
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_timeuint32弹性时间（毫秒）只有flex_on_duty_time，flex_off_duty_time不生效时（值为-1）才有意义
group.checkindate.flex_on_duty_timeint32允许迟到时间（秒），值为-1使用flex_time
group.checkindate.flex_off_duty_timeint32允许早退时间（秒），值为-1使用flex_time
group.spe_workdaysobj[]特殊日期-必须打卡日期，timestamp表示具体时间
group.spe_workdays.timestampuint32特殊日期-必须打卡日期时间戳
group.spe_workdays.notesstring特殊日期备注
group.spe_workdays.checkintimestring特殊日期打卡时间配置，参数同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.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_seuint32上班时间，表示为距离当天0点的秒数。
group.schedulelist.time_section.offwork_secuint3下班时间，表示为距离当天0点的秒数。
group.schedulelist.time_section.remind_work_secuint32上班提醒时间，表示为距离当天0点的秒数。
group.schedulelist.time_section.remind_offwork_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_flexuint32是否允许弹性时间
group.schedulelist.flex_on_duty_timeuint32允许迟到时间（秒），值为-1使用flex_time
group.schedulelist.flex_off_duty_timeuint32允许早退时间（秒），值为-1使用flex_time
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.buka_restrictionuint64补卡指定异常类型，按比特位设置，大端模式，某位bit置位为1表示关闭某类型。从低到高四个比特位分别表示缺卡类型、迟到类型、早退类型、其他异常类型。为默认值0表示所有异常类型均允许补卡。
group.span_day_timeuint32自由上下班规则的跨天时间，表示为距离0点的秒数。
group.standard_work_durationint32自由上下班规则的工作时长（秒），-1表示不限制。

 

上一篇
获取企业所有打卡规则
下一篇
获取打卡记录数据