查询电子签文件详情

该接口可用于批量查询电子签文件列表，并且支持根据文件ID、更新时间范围、文件状态、模板ID等条件检索

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/corehr/v2/signature_files/query
HTTP Method	POST
接口频率限制	100 次/分钟
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	corehr:signature.file:read 查看电子签文件
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

查询参数

名称	类型	必填	描述
signature_file_id	string	否	电子签文件ID，查询结果会返回满足所有筛选条件 signature_file_id 、states、template_ids的文件 示例值：6891251722631890445
page_size	int	否	分页大小 示例值：10 范围：0～100
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：{"eu_nc":"[1724438210000,\"7405949343401772554\"]"}
update_time_start	string	否	更新时间早于等于某个时间点，按照东八区时区 示例值：2022-01-01 00:00:00
update_time_end	string	否	更新时间晚于等于某个时间点，按照东八区时区 示例值：2022-01-02 00:00:00
user_id_type	string	否	用户 ID 类型 示例值：people_corehr_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？ - people_corehr_id: 以飞书人事的 ID 来识别用户 默认值：people_corehr_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
states	string\[\]	否	电子签文件状态状态列表，多个状态之间为「或」的关系；枚举值可通过文档【飞书人事枚举常量】电子签文件状态（signature_file_state）枚举定义部分获得 示例值：["sign_finished","pending_seal"] 数据校验规则： - 长度范围：0 ～ 100
template_ids	string\[\]	否	电子签模板ID列表，返回的电子签文件使用的模板在该数组中； 可以通过【获取电子签模板内容】接口获取模板ID 注意：多个模板ID之间是或的关系 示例值：["7282756156156560940","7282756156156560945"] 数据校验规则： - 长度范围：0 ～ 100

请求体示例

{
    "states": [
        "sign_finished",
        "pending_seal"
    ],
    "template_ids": [
        "7282756156156560940",
        "7282756156156560945"
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	signature_file\[\]	电子签文件信息
└ signature_file_id	string	电子签文件ID，【查询电子签文件信息】
└ names	i18n\[\]	名称
└ lang	string	语言
└ value	string	内容
└ create_time	string	创建时间
└ update_time	string	更新时间
└ employment_id	string	雇员 id
└ pre_hire_id	string	待入职 id
└ signature_file_state	enum	电子签文件状态状态列表，多个状态之间为「或」的关系；枚举值可通过文档【飞书人事枚举常量】电子签文件状态（signature_file_state）枚举定义部分获得
└ enum_name	string	枚举值
└ display	i18n\[\]	枚举多语展示
└ lang	string	语言
└ value	string	文本内容
└ contract_code	string	供应商侧的合同编号，作为幂等key
└ effective_date	string	电子签文件生效日期，格式：yyyy-MM-dd
└ template_id	string	电子签模板ID
└ sign_url	string	签署链接
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{"code":0,
"msg":"success",
"data":{"items":[{
    "signature_file_id": "7147527056140813828",
    "names": [
        {
            "lang": "zh-CN",
            "value": "中文示例"
        }
    ],
    "create_time": "2023-01-01 00:00:00",
    "update_time": "2023-01-01 00:00:00",
    "employment_id": "7123132668099919891",
    "pre_hire_id": "7123132668099919891",
    "signature_file_state": {
        "enum_name": "sign_finished",
        "display": [
            {
                "lang": "zh-CN",
                "value": "签署已完成"
            }
        ]
    },
    "contract_code": "48793beea04f4e2583d50732e481d507",
    "effective_date": "2024-12-01",
    "template_id": "7147527056140813828",
    "sign_url": "123213"
}],
"page_token":"{"cn":"[\"7371387495822411308\"]"}",
"has_more":true}}

错误码

HTTP状态码	错误码	描述	排查建议
500	1160001	system error	系统内部出错，请联系相关技术支持
401	1160002	the max value of limit is 100	limit参数的最大值为100，请将limit的值调整到100或以下
400	1160003	param is invalid	参数非法，请检查输入的参数信息