接口描述
撤销签署中的流程,撤销后签署流程将终止,变为已撤销状态。
注意:如果流程中所有签署方均已签署完成,只是流程未完结,这种情况对用户来讲已经是有效的签署了,如果开发者要撤销,需要在业务内提前与签署方确认同意后,再调用该接口撤销。如果未经客户允许就单方面调撤销接口把流程结束,会存在一定风险。(点击了解 签署流程状态详解)
接口地址&请求方法
接口地址:https://{host}/v3/sign-flow/{signFlowId}/revoke
请求方法:POST
请求头格式
具体请求头参数,请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
signFlowId | string | 是 | path | 签署流程ID |
revokeReason | string | 否 | body | 撤销原因 补充说明:
|
响应参数
参数名称 | 参数类型 | 必选 | 参数说明 | ||||
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | ||||
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message 匹配,因为 message 可能会调整。 | ||||
data | object | 否 | 业务数据 |
请求示例
POST https://openapi.esign.cn/v3/sign-flow/429b1d30**0a63d7e4c0d/revoke
{
"revokeReason": "合同条款错误"
}
响应示例
{
"code": 0,
"message": "成功",
"data": {}
}