文档变更
2022年时,签署流程开启变为开启签署流程,以便开发者更容易理解,仅中文名称变更,其功能保持不变。
接口描述
开启签署流程,签署任务会自动按照设置开始流转。
注意:
(1)签署流程开启后,不能删除流程已关联的文档。
(2)签署流程开启后,不能向流程再新添加文档。
(3)签署流程内 autoArchive 参数值设置true(自动结束)时,流程开启后,不能增加签署区。
(4)签署流程内 autoArchive 参数值设置false(非自动结束)时,流程开启后且未结束,允许增加签署区。
接口地址&请求方式
接口地址: /v1/signflows/{flowId}/start
请求方式:PUT
请求头格式
具体请求头格式结构,请点击查看公共参数说明。
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 (左右拖动查看完整描述) |
flowId | string | 是 | path | 签署流程ID |
响应参数
参数名称 | 类型 | 必选 | 参数说明 (左右拖动查看完整描述) |
code | int | 是 | 业务码,0表示成功 |
message | string | 否 | 业务信息 |
data | object | 否 | 业务数据 |
请求示例
PUT https://openapi.esign.cn/v1/signflows/429b1d3038854cabbcdac0a63d7e4c0d/start
响应示例
{ "code":0, "message":"成功", "data":null }
错误码
错误码 | 错误描述 | 排查方法 (左右拖动查看完整描述) |
1437108 | 非草稿状态不允许开启流程 | 流程不是草稿状态, 已经发起或已经完结 |
1437109 | 流程没有文档不允许开启流程 | 流程没有添加签署文档, 不能开启流程 |
1437110 | 流程没有签署区不允许开启流程 | 自动归档场景下, 流程还没有添加签署区, 不能开启流程 |
1435404 | 机构账户中签署份数不足,请购买套餐后再操作 | 当前机构签署份数不足且当前操作用户是机构管理员 |
1435405 | 机构账户中签署份数不足,请联系管理员(%s,%s)购买套餐后再操作 | 当前机构签署份数不足且当前操作用户不是机构管理员 |
1435403 | 账户中签署份数不足,请购买套餐后再操作 | 当前个人账户签署份数不足 |
401 | 1.token过期了 2.header请求头不正确 3.apiurl和应用ID环境不对应,例如apiurl是模拟环境,应用ID是正式环境的 |