终止电子签文件

该接口用于终止在签署流程中的电子签文件，不再执行后续的签署流程

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/corehr/v2/signature_files/terminate
HTTP Method	POST
接口频率限制	100 次/分钟
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	corehr:signature_file:terminate 终止电子签文件
字段权限要求	> 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"

查询参数

名称	类型	必填	描述
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

请求体

名称	类型	必填	描述
ids	string\[\]	是	欲终止的电子签文件id列表，文件ID可以通过调用「获取电子签文件列表」接口获取 示例值：["7410063506638112300"] 数据校验规则： - 长度范围：0 ～ 100
operator	string	是	操作人ID，ID的格式取决于query传参中传入的user_id_type字段；ID获取方式见「查询参数」 示例值："7386593105085988xxx"
terminate_reason	string	是	终止原因，不得超过300字符 示例值："请求流程发生变化，需要重新签署，因此终止签署流程中的文件"

请求体示例

{
    "ids": [
        "7410063506638112300"
    ],
    "operator": "7386593105085988xxx",
    "terminate_reason": "请求流程发生变化，需要重新签署，因此终止签署流程中的文件"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ total_count	int	欲终止的文件总数量
└ success_count	int	成功总数量
└ fail_count	int	失败总数量
└ success_file_id_list	string\[\]	终止成功的文件id列表，可以通过【获取电子签文件列表】接口获取文件详情信息
└ fail_file_id_and_reasons	terminate_signature_fail_id_and_reason\[\]	终止失败的文件id和对应的原因列表
└ signature_file_id	string	终止操作失败的文件ID，可以通过【获取电子签文件列表】接口获取文件详情信息
└ fail_reason	string	终止失败的原因

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "total_count": 2,
        "success_count": 1,
        "fail_count": 1,
        "success_file_id_list": [
            "7410063506638112300"
        ],
        "fail_file_id_and_reasons": [
            {
                "signature_file_id": "7345403447803379731",
                "fail_reason": "文件状态不允许终止"
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	1160001	system error	系统内部出错，请联系相关技术支持
400	1160002	文件未找到，请检查传入的文件ID是否正确（如示例值格式是否为["7410063506638112300"]），或确认该文件是否存在。若问题持续，请联系技术支持	系统内部出错，请联系相关技术支持