Skip to content

获取补卡记录

补卡:用户通过审批的方式,在某一次上/下班的打卡时间范围内,补充一条打卡记录,用以修正用户的考勤结果。本接口专用于获取员工的补卡记录(无页面功能对应)

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/attendance/v1/user_task_remedys/query
HTTP MethodPOST
接口频率限制50 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用attendance:task:readonly 导出打卡数据

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

查询参数

名称类型必填描述
employee_typestring请求体中的 user_ids 和响应体中的 user_id 的员工ID类型。如果没有后台管理权限,可使用通过手机号或邮箱获取用户 ID
示例值:employee_id
可选值有
- employee_id: 员工 employee ID,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的用户 ID - employee_no: 员工工号,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的工号

请求体

名称类型必填描述
user_idsstring\[\]employee_no 或 employee_id 列表。传入的ID类型需要与employee_type的取值一致。最多支持50个
示例值:["abd754f7"]
check_time_fromstring查询的起始时间,精确到秒的时间戳
示例值:"1566641088"
check_time_tostring查询的结束时间,精确到秒的时间戳
示例值:"1592561088"
check_date_typestring查询依据的时间类型(默认依据PeriodTime,如果使用非默认的,非特定租户不支持)
示例值:"PeriodTime"
可选值有
- PeriodTime: 单据作用时间 - CreateTime: 单据创建时间(目前暂不支持) - UpdateTime: 单据状态更新时间
statusint查询状态(不填默认查询已通过状态)
示例值:2
可选值有
- 0: 待审批 - 1: 未通过 - 2: 已通过 - 3: 已取消 - 4: 已撤回

请求体示例

json
{
    "user_ids": [
        "abd754f7"
    ],
    "check_time_from": "1566641088",
    "check_time_to": "1592561088",
    "status": 2
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ user_remedysuser_task_remedy\[\]补卡记录列表
    └ user_idstring用户 ID,对应employee_type
    └ remedy_dateint补卡日期,格式为yyyyMMdd
    └ punch_noint第几次上下班,0:第 1 次上下班,1:第 2 次上下班,2:第 3 次上下班,自由班制填 0
    └ work_typeint上班 / 下班,1:上班,2:下班,自由班制为 1
    └ approval_idstring审批 ID,可用于通知审批状态更新
    └ remedy_timestring补卡时间,时间格式为 yyyy-MM-dd HH:mm
    └ statusint补卡状态
可选值有
- 0: 审批中 - 1: 未通过 - 2: 已通过 - 3: 已取消 - 4: 通过后撤回
    └ reasonstring补卡原因
    └ timestring补卡时间,精确到秒的时间戳
    └ time_zonestring补卡时考勤组时区
    └ create_timestring补卡发起时间,精确到秒的时间戳
    └ update_timestring补卡状态更新时间,精确到秒的时间戳

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "user_remedys": [
            {
                "user_id": "abd754f7",
                "remedy_date": 20210701,
                "punch_no": 0,
                "work_type": 1,
                "approval_id": "6737202939523236113",
                "remedy_time": "2021-07-01 08:00",
                "status": 2,
                "reason": "忘记打卡",
                "time": "1611476284",
                "time_zone": "Asia/Shanghai",
                "create_time": "1611476284",
                "update_time": "1611476284"
            }
        ]
    }
}

错误码

HTTP状态码错误码描述排查建议
4001220001param is invalid入参校验失败,请根据具体返回的信息检查入参。例如“employee_type invalid”代表人员类型异常。如仍无法解决可联系 技术支持
4001220002tenant_id is empty请检查入参中的 tenant_access_token是否正确
4001220004param is invalid请参考实际返回的错误信息排查问题。例如“user_id is not exist or does not have permission”代表入参传入的用户id不存在或者没有权限。如仍无法解决可联系 技术支持
4001220005permission denied请前往考勤管理后台检查数据权限范围
4001220600general error message通用错误信息包含多条,详细的错误信息以及处理建议可参见 错误信息
5001225000param is invalid请参考实际返回的错误信息排查问题。例如“internal server error”代表内部服务异常。如仍无法解决可联系 技术支持
5001226500historical error code, no longer in use历史错误码,不再使用

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