Skip to content

查询所有班次

飞书人事管理后台中假勤设置-班次配置中的翻页查询所有班次功能,展示班次名称、打卡规则、弹性班次规则、休息规则等

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/attendance/v1/shifts
HTTP MethodGET
接口频率限制50 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可attendance:rule 写入打卡管理规则 attendance:rule:readonly 导出打卡管理规则

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

查询参数

名称类型必填描述
page_sizeint分页大小
示例值:10
默认值10
数据校验规则
- 取值范围:150
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:YrkvQ1wGaPVta45tkxuGiQ==

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ shift_listshift\[\]班次列表
    └ shift_idstring班次 ID
    └ shift_namestring班次名称
    └ punch_timesint打卡次数
    └ sub_shift_leader_idsstring\[\]无效字段,请勿使用
    └ is_flexibleboolean是否弹性打卡
    └ flexible_minutesint弹性打卡时间,单位:分钟,设置【上班最多可晚到】与【下班最多可早走】时间,如果不设置flexible_rule则生效
    └ flexible_ruleflexible_rule\[\]弹性打卡时间设置
      └ flexible_early_minutesint下班最多可早走,单位:分钟(上班早到几分钟,下班可早走几分钟)
      └ flexible_late_minutesint上班最多可晚到,单位:分钟(上班晚到几分钟,下班须晚走几分钟)
    └ no_need_offboolean不需要打下班卡
    └ punch_time_rulepunch_time_rule\[\]打卡规则
      └ on_timestring上班时间,格式为hh:mm
      └ off_timestring下班时间,格式为hh:mm。如果是第二天凌晨2点, 则为26:00
      └ late_minutes_as_lateint晚到多久记为迟到,单位:分钟
      └ late_minutes_as_lackint晚到多久记为缺卡,单位:分钟
      └ on_advance_minutesint最早多久可打上班卡,单位:分钟
      └ early_minutes_as_earlyint早退多久记为早退,单位:分钟
      └ early_minutes_as_lackint早退多久记为缺卡,单位:分钟
      └ off_delay_minutesint最晚多久可打下班卡,单位:分钟
      └ late_minutes_as_serious_lateint晚到多久记为严重迟到,单位:分钟
      └ no_need_onbooleantrue为需要打上班卡,false为不需要上班打卡。 注意和接口创建时的区别:接口创建时,no_need_on传参false表示需要打上班卡,true为不需要打上班卡
      └ no_need_offbooleantrue为需要打下班卡,false为不需要下班打卡。 注意和接口创建时的区别:接口创建时,no_need_off传参false表示需要打下班卡,true为不需要打下班卡
    └ late_off_late_on_rulelate_off_late_on_rule\[\]晚走晚到规则(仅飞书人事企业版可用)
      └ late_off_minutesint晚走多久,单位:分钟
      └ late_on_minutesint晚到多久,单位:分钟
    └ rest_time_rulerest_rule\[\]休息规则
      └ rest_begin_timestring休息开始
      └ rest_end_timestring休息结束
    └ overtime_ruleovertime_rule\[\]加班时段(仅飞书人事企业版可用)
      └ on_overtimestring开始时间
      └ off_overtimestring结束时间
    └ day_typeint日期类型,【是否弹性打卡 = true】时,不可设置为“休息日” 可选值:1:工作日 2:休息日 示例值:(默认值)1
    └ overtime_rest_time_rulerest_rule\[\]班外休息规则
      └ rest_begin_timestring休息开始
      └ rest_end_timestring休息结束
    └ late_minutes_as_serious_lateint晚到多久记为严重迟到,单位:分钟(优先级比原有字段高)
    └ shift_middle_time_ruleshift_middle_time_rule半天分割规则(仅飞书人事企业版可用)
      └ middle_time_typeint半天分割类型
可选值有
- 0: 按全天班次时长(含休息)的中点分割 - 1: 按全天班次时长(不含休息)的中点分割 - 2: 按休息时间分割 - 3: 按固定时间点分割
      └ fixed_middle_timestring固定分割时间点(middle_time_type 为 3 时有效)
    └ late_off_late_on_settinglate_off_late_on_setting晚走次日晚到配置规则
      └ late_off_base_on_time_typeint当日晚走时间计算规则
可选值有
- 0: 弹性规则 - 1: 固定规则
      └ late_on_base_on_time_typeint次日晚到时间计算规则
可选值有
- 0: 固定规则 - 1: 弹性规则
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "shift_list": [
            {
                "shift_id": "6919358778597097404",
                "shift_name": "早班",
                "punch_times": 1,
                "sub_shift_leader_ids": [
                    "456123"
                ],
                "is_flexible": false,
                "flexible_minutes": 60,
                "flexible_rule": [
                    {
                        "flexible_early_minutes": 60,
                        "flexible_late_minutes": 60
                    }
                ],
                "no_need_off": true,
                "punch_time_rule": [
                    {
                        "on_time": "9:00",
                        "off_time": "18:00",
                        "late_minutes_as_late": 30,
                        "late_minutes_as_lack": 60,
                        "on_advance_minutes": 60,
                        "early_minutes_as_early": 30,
                        "early_minutes_as_lack": 60,
                        "off_delay_minutes": 60,
                        "late_minutes_as_serious_late": 40,
                        "no_need_on": true,
                        "no_need_off": true
                    }
                ],
                "late_off_late_on_rule": [
                    {
                        "late_off_minutes": 60,
                        "late_on_minutes": 30
                    }
                ],
                "rest_time_rule": [
                    {
                        "rest_begin_time": "13:00",
                        "rest_end_time": "14:00"
                    }
                ],
                "overtime_rule": [
                    {
                        "on_overtime": "9:00",
                        "off_overtime": "18:00"
                    }
                ],
                "day_type": 1,
                "overtime_rest_time_rule": [
                    {
                        "rest_begin_time": "13:00",
                        "rest_end_time": "14:00"
                    }
                ],
                "late_minutes_as_serious_late": 40,
                "shift_middle_time_rule": {
                    "middle_time_type": 0,
                    "fixed_middle_time": "12:00"
                },
                "late_off_late_on_setting": {
                    "late_off_base_on_time_type": 0,
                    "late_on_base_on_time_type": 0
                }
            }
        ],
        "page_token": "YrkvQ1wGaPVta45tkxuGiQ==",
        "has_more": true
    }
}

错误码

HTTP状态码错误码描述排查建议
4001220001param is invalid入参校验失败,请根据具体返回的信息检查入参。例如“employee_type invalid”代表人员类型异常。如仍无法解决可联系 技术支持
4001220002tenant_id is empty请检查入参中的 tenant_access_token是否正确
5001225000param is invalid请参考实际返回的错误信息排查问题。例如“internal server error”代表内部服务异常。如仍无法解决可联系 技术支持
5001226000param is invalid班次服务异常错误码,请参考实际返回的错误信息排查问题。例如“internal server error”代表内部服务异常。如仍无法解决可联系 技术支持
4001226003param is invalid请参考实际返回的错误信息排查问题。例如“default shift are not allowed to change.”代表默认班次不能修改。如仍无法解决可联系 技术支持
4001220600通用错误信息通用错误信息包含多条,详细的错误信息以及处理建议可参见 错误信息

内容来源:飞书开放平台 · 自动爬取整理