根据流程获取电子签文件信息

该接口可以根据传入的业务类型和流程ID获取该流程中签署的电子签文件信息

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/corehr/v2/signature_files/list_by_biz_id
HTTP Method	GET
接口频率限制	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

查询参数

名称	类型	必填	描述
biz_process_id	string	是	业务自定义流程ID，唯一不重复，不要超过100字符 示例值：129b83f5-c023-4e85-b2c7-80ce777e57fd
biz_type	string	是	业务类型，开放平台发起的流程传OpenAPI，BPM发起的流程传入Bpm，目前只支持这两种业务类型 示例值：OpenAPI、Bpm
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
select_sign_url	boolean	否	是否需要返回签署链接 示例值：true

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ signature_files	signature_file\[\]	返回的流程关联的电子签文件列表
└ signature_file_id	string	电子签文件ID
└ names	i18n\[\]	名称
└ lang	string	语言
└ value	string	文本内容
└ create_time	string	创建时间，格式：YYYY-MM-DD 00:00:00
└ update_time	string	更新时间，格式：YYYY-MM-DD 00:00:00
└ 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	电子签文件生效日期
└ template_id	string	电子签模板ID，可以通过【根据ID获取电子签模板】获取电子签模板详情信息
└ sign_url	string	签署链接
└ batch_sign_url	string	批量签署链接

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "signature_files": [
            {
                "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": "pending_sign",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "待签字"
                        }
                    ]
                },
                "contract_code": "48793beea04f4e2583d50732e481d507",
                "effective_date": "2024-12-01",
                "template_id": "7147527056140813828",
                "sign_url": "https://www.letsign.com/v2/saas/sign?signCode=05325cb58b77484f92d4b145c18222cf&taskCode=batch-0-4639de2ddcb54439b7f31517a17b7b4c"
            }
        ],
        "batch_sign_url": "https://www.letsign.com/v2/saas/sign?signCode=05325cb58b77484f92d4b145c18222cf&taskCode=batch-0-4639de2ddcb54439b7f31517a17b7b4c"
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1160001	param is invalid	请检查传入参数的类型、格式或值是否符合接口要求（如biz_process_id需满足传入的业务类型的字符串格式、biz_type需为OpenAPI或Bpm等）