Skip to content

获取门禁记录列表

用户在门禁考勤机上成功开门或打卡后,智能门禁应用都会生成一条门禁记录。

该接口返回满足查询参数的识别记录。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/acs/v1/access_records
HTTP MethodGET
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用acs:access_record:readonly 查看智能门禁记录
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

查询参数

名称类型必填描述
page_sizeint分页大小
示例值:100
默认值100
数据校验规则: - 最大值:500
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:"AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw="
fromint记录开始时间,单位秒
示例值:1624520521
toint记录结束时间,单位秒, 时间跨度不能超过30天
示例值:1624520521
device_idstring门禁设备 ID
示例值:"7091146989218002577"
user_id_typestring用户 ID 类型
示例值:"open_id"
可选值有
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?
默认值open_id
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemsaccess_record\[\]-
    └ access_record_idstring门禁记录 ID
    └ user_idstring门禁记录所属用户 ID
    └ device_idstring门禁设备 ID
    └ is_clock_inboolean是否是打卡
    └ access_timestring访问时间,单位秒
    └ access_typestring识别方式
可选值有
- FA: 人脸识别方式
    └ access_datastring识别相关数据,根据 access_type 不同,取值不同
    └ is_door_openboolean是否开门
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "access_record_id": "6939433228970082591",
                "user_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
                "device_id": "6939433228970082593",
                "is_clock_in": true,
                "access_time": "1624520221",
                "access_type": "FA",
                "access_data": "{\"has_access_photo\":true}",
                "is_door_open": true
            }
        ],
        "page_token": "AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw=",
        "has_more": true
    }
}

错误码

HTTP状态码错误码描述排查建议
4001490018page token is invalid error重新获取 page token
4001490017time range oversize error减少查询时间范围

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