服务端 API/考勤打卡/考勤班次/创建班次
# 创建班次
班次是描述一次考勤任务时间规则的统称，比如一天打多少次卡，每次卡的上下班时间，晚到多长时间算迟到，晚到多长时间算缺卡等。
**注意事项**：- 创建一个考勤组前，必须先创建一个或者多个班次。
- 一个公司内的班次是共享的，你可以直接引用他人创建的班次，但是需要注意的是，若他人修改了班次，会影响到你的考勤组及其考勤结果。
## 请求
基本 |
---|---
HTTP URL | https://open.larksuite.com/open-apis/attendance/v1/shifts
HTTP Method | POST
支持的应用类型 | Custom App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 写入打卡管理规则(attendance:rule)
### 请求头
名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"
[了解更多：获取与使用access_token](https://open.larksuite.com/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"
### 请求体
名称 | 类型 | 必填 | 描述
---|---|---|---
shift_name | string | 是 | 班次名称
**示例值**："早班"
punch_times | int | 是 | 打卡次数
**示例值**：1
is_flexible | boolean | 否 | 是否弹性打卡
**示例值**：false
flexible_minutes | int | 否 | 弹性打卡的时间
**示例值**：60
no_need_off | boolean | 否 | 不需要打下班卡
**示例值**：true
punch_time_rule | punch_time_rule\[\] | 是 | 打卡规则
∟ on_time | string | 是 | 上班时间
**示例值**："9:00"
∟ off_time | string | 是 | 下班时间
**示例值**："18:00， 第二天凌晨2点， 26:00"
∟ late_minutes_as_late | int | 是 | 晚到多久记为迟到
**示例值**：30
∟ late_minutes_as_lack | int | 是 | 晚到多久记为缺卡
**示例值**：60
∟ on_advance_minutes | int | 是 | 最早多久可打上班卡
**示例值**：60
∟ early_minutes_as_early | int | 是 | 早退多久记为早退
**示例值**：30
∟ early_minutes_as_lack | int | 是 | 早退多久记为缺卡
**示例值**：60
∟ off_delay_minutes | int | 是 | 最晚多久可打下班卡
**示例值**：60
late_off_late_on_rule | late_off_late_on_rule\[\] | 否 | 晚走晚到规则
∟ late_off_minutes | int | 是 | 晚走多久
**示例值**：60
∟ late_on_minutes | int | 是 | 晚到多久
**示例值**：30
rest_time_rule | rest_rule\[\] | 否 | 休息规则
∟ rest_begin_time | string | 是 | 休息开始
**示例值**："13:00"
∟ rest_end_time | string | 是 | 休息结束
**示例值**："14:00"
### 请求体示例
```json
{
"shift_name": "早班",
"punch_times": 1,
"is_flexible": false,
"flexible_minutes": 60,
"no_need_off": true,
"punch_time_rule": [
{
"on_time": "9:00",
"off_time": "26: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_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"
}
]
}
```
## 响应
### 响应体
名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
∟ shift | shift | 班次
∟ shift_id | string | 班次 ID
∟ shift_name | string | 班次名称
∟ punch_times | int | 打卡次数
∟ is_flexible | boolean | 是否弹性打卡
∟ flexible_minutes | int | 弹性打卡的时间
∟ no_need_off | boolean | 不需要打下班卡
∟ punch_time_rule | punch_time_rule\[\] | 打卡规则
∟ on_time | string | 上班时间
∟ off_time | string | 下班时间
∟ late_minutes_as_late | int | 晚到多久记为迟到
∟ late_minutes_as_lack | int | 晚到多久记为缺卡
∟ on_advance_minutes | int | 最早多久可打上班卡
∟ early_minutes_as_early | int | 早退多久记为早退
∟ early_minutes_as_lack | int | 早退多久记为缺卡
∟ off_delay_minutes | int | 最晚多久可打下班卡
∟ late_off_late_on_rule | late_off_late_on_rule\[\] | 晚走晚到规则
∟ late_off_minutes | int | 晚走多久
∟ late_on_minutes | int | 晚到多久
∟ rest_time_rule | rest_rule\[\] | 休息规则
∟ rest_begin_time | string | 休息开始
∟ rest_end_time | string | 休息结束
### 响应体示例
```json
{
"code": 0,
"msg": "success",
"data": {
"shift": {
"shift_id": "6919358778597097404",
"shift_name": "早班",
"punch_times": 1,
"is_flexible": false,
"flexible_minutes": 60,
"no_need_off": true,
"punch_time_rule": [
{
"on_time": "9:00",
"off_time": "26: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_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"
}
]
}
}
}
```
### 错误码
HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 1220001 | 参数错误 | 请检查参数是否符合要求
400 | 1220002 | 租户不存在 | 请检查 tenant_access_token 是否正确
400 | 1220005 | 没有权限 | 请前往[考勤管理后台](https://oa.larksuite.com/attendance/manage/member/list)检查数据权限范围
500 | 1225000 | 系统错误 | 详见错误信息
500 | 1226000 | 班次服务系统错误 | 详见错误信息
400 | 1226001 | 班次已被使用 | 请修改班次名称
400 | 1226002 | 班次名称已被使用 | 请修改班次名称