# 批量查询打卡流水

通过用户 ID 获取用户的打卡流水记录。返回信息主要包含：
* 用户id和创建者id
* 记录信息
* 打卡位置信息、时间信息
* 打卡方式信息
   * GPS 打卡：location_name（定位地址信息）
   * Wi-Fi 打卡：ssid（wifi名称）、bssid（mac地址）
   * 考勤机打卡：device_id（考勤机设备id）

对应页面功能打卡管理-[打卡记录](https://example.feishu.cn/people/workforce-management/manage/statistics/flow)

**注意事项**：这里只返回有效的打卡流水，无效或待生效的不会返回
**注意事项**：如果只需获取打卡结果，而不需要详细的打卡数据，可使用“获取打卡结果”的接口。

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/attendance/v1/user_flows/query
HTTP Method | POST
接口频率限制 | [50 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 导出打卡数据(attendance:task:readonly)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
employee_type | string | 是 | 请求体中的 user_ids 和响应体中的 user_id 的员工ID类型。如果没有后台管理权限，可使用[通过手机号或邮箱获取用户 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id)<br>**示例值**：employee_id<br>**可选值有**：<br>- employee_id：员工 employee ID，即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的用户 ID<br>- employee_no：员工工号，即[飞书管理后台](https://example.feishu.cn/admin/contacts/departmentanduser) > 组织架构 > 成员与部门 > 成员详情中的工号
include_terminated_user | boolean | 否 | 由于新入职用户可以复用已离职用户的employee_no/employee_id。如果true，返回employee_no/employee_id对应的所有在职+离职用户数据；如果false，只返回employee_no/employee_id对应的在职或最近一个离职用户数据<br>**示例值**：true

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
user_ids | string\[\] | 是 | employee_no 或 employee_id 列表，长度不超过 50<br>**示例值**：["abd754f7"]
check_time_from | string | 是 | 查询的起始时间，秒级时间戳<br>**示例值**："1566641088"
check_time_to | string | 是 | 查询的结束时间，秒级时间戳<br>**示例值**："1566641088"

### 请求体示例
```json
{
    "user_ids": [
        "abd754f7"
    ],
    "check_time_from": "1566641088",
    "check_time_to": "1566641088"
}
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
user_flow_results | user_flow\[\] | 打卡记录列表
user_id | string | 用户 ID，对应employee_type
creator_id | string | 记录创建者 ID，对应employee_type
location_name | string | 打卡位置名称信息
check_time | string | 打卡时间，秒级时间戳
comment | string | 打卡备注
record_id | string | 对应打卡流水记录ID
ssid | string | 打卡 Wi-Fi 的 SSID
bssid | string | 打卡 Wi-Fi 的 MAC 地址
is_field | boolean | 是否为外勤打卡
is_wifi | boolean | 是否为 Wi-Fi 打卡
type | int | 记录生成方式，在开放平台调用时，此参数无效，内部值始终是7<br>**可选值有**：<br>- 0：用户打卡<br>- 1：管理员修改<br>- 2：用户补卡<br>- 3：系统自动生成<br>- 4：下班免打卡<br>- 5：考勤机<br>- 6：极速打卡<br>- 7：考勤开放平台导入
photo_urls | string\[\] | 打卡照片列表
device_id | string | 打卡设备ID（只支持小程序打卡，导入时无效）
check_result | string | 无效字段。如需获取打卡结果请使用[获取打卡结果](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/user_task/query)<br>**可选值有**：<br>- NoNeedCheck：无需打卡<br>- SystemCheck：系统打卡<br>- Normal：正常<br>- Early：早退<br>- Late：迟到<br>- SeriousLate：严重迟到<br>- Lack：缺卡<br>- Invalid：无效<br>- None：无状态<br>- Todo：尚未打卡
external_id | string | 用户导入的外部打卡记录ID
idempotent_id | string | 唯一幂等键

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "user_flow_results": [
            {
                "user_id": "abd754f7",
                "creator_id": "abd754f7",
                "location_name": "西溪八方城",
                "check_time": "1611476284",
                "comment": "上班打卡",
                "record_id": "6709359313699356941",
                "ssid": "b0:b8:67:5c:1d:72",
                "bssid": "b0:b8:67:5c:1d:72",
                "is_field": true,
                "is_wifi": true,
                "type": 7,
                "photo_urls": [
                    "https://time.clockin.biz/manage/download/6840389754748502021"
                ],
                "device_id": "99e0609ee053448596502691a81428654d7ded64c7bd85acd982d26b3636c37d",
                "check_result": "PendingApproval",
                "external_id": "record_123",
                "idempotent_id": "****_***"
            }
        ]
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 1220001 | param is invalis | 入参校验失败，请根据具体返回的信息检查入参。例如“employee_type invalid”代表人员类型异常。如仍无法解决可联系 [技术支持](https://applink.feishu.cn/TLJpeNdW)
400 | 1220002 | 租户不存在 | 请检查入参中的 tenant_access_token是否正确
400 | 1220004 | param is invalis | 请参考实际返回的错误信息排查问题。例如“user_id is not exist or does not have permission”代表入参传入的用户id不存在或者没有权限。如仍无法解决可联系 [技术支持](https://applink.feishu.cn/TLJpeNdW)
400 | 1220005 | 没有权限 | 请前往[考勤管理后台](https://oa.feishu.cn/attendance/manage/member/list)检查数据权限范围
500 | 1225000 | param is invalis | 请参考实际返回的错误信息排查问题。例如“internal server error”代表内部服务异常。如仍无法解决可联系 [技术支持](https://applink.feishu.cn/TLJpeNdW)
500 | 1226500 | 历史错误码，不再使用 | -
500 | 1227500 | param is invalis | 班次服务异常错误码，请参考实际返回的错误信息排查问题。例如“[BatchGetLarkIDByOpenID] not find user larkID”代表没有找到对应lark uid。如仍无法解决可联系 [技术支持](https://applink.feishu.cn/TLJpeNdW)
400 | 1220600 | 通用错误信息 | 通用错误信息包含多条，详细的错误信息以及处理建议可参见 [错误信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/attendance-v1/attendance-development-guidelines)