签署流程撤销

更新时间:2023-09-26 11:16:32

接口描述

撤销签署流程,撤销后流程中止,所有签署无效。

接口

/v1/signflows/{flowId}/revoke

请求方式

PUT

请求头

提供两种安全接入方式,开发者可选择其中一种方式进行对接,对应参数如何获取,参考文档【请点击】。

方式一:请求签名鉴权

请求头入参示例如下:

参数名称

类型

必选

参数说明

X-Tsign-Open-App-Id

string

项目ID

Content-Type

string

application/json;charset=UTF-8

X-Tsign-Open-Ca-Timestamp

string

API 调用者传递时间戳,值为当前时间的毫秒数,也就是从1970年1月1日起至今的时间转换为毫秒,时间戳有效时间为15分钟,为了防重放攻击

Accept

string

建议统一填写 */*

X-Tsign-Open-Ca-Signature

string

签名字符串

Content-MD5

string

当请求 Body 非 Form 表单时,可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时,加上此请求头。

X-Tsign-Open-Auth-Mode

string

选择请求方式进行鉴权,固定值,Signature

方式二:OAuth2.0鉴权

当安全接入选择OAuth2.0鉴权方式请点击查阅详情,请求头入参示例如下:

参数名称

类型

必选

参数说明

X-Tsign-Open-App-Id

string

项目ID

X-Tsign-Open-Token

string

通过获取鉴权Token接口返回

Content-Type

string

application/json; charset=UTF-8


请求参数

参数名称

类型

必选

参数类型

参数说明

flowId

string

path

流程id该参数需放在请求地址里面,可以参考【请求示例】

operatorId

string

body

发起人账户id,即发起本次签署的操作人个人账号id;如不传,默认由对接平台发起

revokeReason

string

body

撤销原因,默认"撤销"(最长400字节)

补充说明:

  • 撤销原因不可含有以下9个特殊字符:/ \ : * " < > | ?以及所有emoji表情

公共响应参数

参数名称

类型

必选

参数说明

code

int

业务码,0表示成功

message

string

信息

data

object

业务信息

请求示例  

PUT https://openapi.esign.cn/v1/signflows/429b1d3038854cabbcdac0a63d7e4c0d/revoke


{
    "operatorId":"40eb61714d9e49088bac7a3c56d69d66",
    "revokeReason":"合同撤销:合同内容有误"
}

响应示例

{
    "code":0,
    "message":"成功",
    "data":null
}

错误码

错误码

错误描述

解决方案

1437111

非开启状态不允许撤回流程

非签署中的流程状态,无法撤销

1437168

流程已撤销

重复调用撤销接口导致

1437148

当前用户不是流程发起人, 不能撤回流程

请传入正确的发起人账号id

1438108

更新合同管理流程状态异常

撤销原因revokeReason控制在400个字节以内


我要纠错