流程模板服务API V3

更新时间:2024-01-11 17:10:17

流程模板的制作与查询

获取《创建流程模板》页面链接

POST /v3/sign-templates/sign-template-create-url

code 错误码

message 错误信息

1451000

参数错误:%s

1451002

服务异常

1451004

应用不存在

1451006

用户未授权:%s,%s

1451029

成员不在该组织

1451021

当前操作人无权限操作模板

开启流程模板

POST /v3/sign-templates/enable

code 错误码

message 错误信息

1451006

用户未授权:%s,%s

1451021

当前操作人无权限操作模板

1451026

流程模板不存在

1451042

共享模板不支持该操作

1451043

模板不属于该企业,无法操作

停用流程模板

POST /v3/sign-templates/disable

code 错误码

message 错误信息

1451006

用户未授权:%s,%s

1451021

当前操作人无权限操作模板

1451026

流程模板不存在

1451042

共享模板不支持该操作

1451043

模板不属于该企业,无法操作

获取《编辑流程模板》页面链接

POST /v3/sign-templates/{signTemplateId}/sign-template-edit-url

code 错误码

message 错误信息

1451004

应用不存在

1451002

服务异常

1451006

用户未授权:%s,%s

1451000

参数错误:%s

1451029

成员不在该组织

1451021

当前操作人无权限操作模板

1451022

流程模板不存在,无法编辑

1451024

共享流程模板不可编辑

1451023

流程模板非禁用状态,无法编辑

1451046

API暂不支持动态流程模板

1451049

API不支持的模板类型

1451043

模板不属于该企业,无法操作

查询流程模板详情

GET /v3/sign-templates/detail

code 错误码

message 错误信息

1451006

用户未授权:%s,%s

1451026

流程模板不存在

1451043

模板不属于该企业,无法操作

查询流程模板列表

GET /v3/sign-templates

code 错误码

message 错误信息

1451006

用户未授权:%s,%s

查询用户在某企业下能否编辑或使用某流程模板

GET /v3/sign-templates/permission

code 错误码

message 错误信息

1451006

用户未授权:%s,%s

1451026

流程模板不存在

1451043

模板不属于该企业,无法操作

删除流程模板

POST /v3/sign-templates/delete

code 错误码

message 错误信息

1451006

用户未授权:%s,%s

1451027

开启失败:%s

1451021

当前操作人无权限操作模板

1451026

流程模板不存在

1451042

共享模板不支持该操作

1451043

模板不属于该企业,无法操作

复制流程模板

POST /v3/sign-templates/copy

code 错误码

message 错误信息

1451006

用户未授权:%s,%s

1451021

当前操作人无权限操作模板

1451026

流程模板不存在

1451042

共享模板不支持该操作

1451043

模板不属于该企业,无法操作

1451067

复制流程模板失败: %s

流程模板的合同拟定与签署

通过流程模板创建合同拟定和签署流程

POST /v3/sign-flow/create-by-sign-template

code 错误码

message 错误信息

1451000

参数错误: chargeMode无对应枚举值

1451000

参数错误: orderType无对应枚举值

1451000

参数错误: 签署方付费模式仅支持使用渠道套餐,请调整后重试

1451000

参数错误: 通知方式不支持

1451000

参数错误: 签署终端类型不支持

1451000

参数错误: 签署截止时间signFlowExpireTime不能超过发起后90天

1451000

参数错误: 流程过期时间signFlowExpireTime不能早于当前时间

1451000

参数错误: 同一个参与方,个人和机构不能同时为空或同时传值

1451000

参数错误: 个人参与方psnId、psnAccount不能同时传值或同时为空

1451000

参数错误: 个人参与方psnId、psnName不能同时传值

1451000

参数错误: 企业参与方orgId、orgName不能同时传值或同时为空

1451000

参数错误: 企业参与方经办人transactorPsnId、transactorPsnAccount不能同时传值或同时为空

1451000

参数错误: 企业参与方经办人transactorPsnAccount、transactorName必须同时传值

1451000

参数错误: 企业参与方经办人transactorPsnId、transactorName不能同时传值

1451000

参数错误: 企业参与方与经办人传入必须为orgId与transactorPsnId或orgName与transactorPsnAccount

1451000

参数错误: 参与方participantId不能重复

1451000

参数错误: 参与方个人账号xxx姓名不统一

1451000

参数错误: copierPsnInfo不能为空

1451000

参数错误: 抄送人psnId、psnAccount不能同时传值或同时为空

1451000

参数错误: 机构抄送方orgId、orgName不能同时传值或同时为空

1451000

参数错误: 个人抄送方、机构抄送方必须都传id或者账号

1451000

参数错误: componentId和componentKey不能同时传值或同时为空

1451000

参数错误: 控件id或控件key不能重复

1451000

参数错误: 参与方未指定,participantId:xxx

(场景:指定参与方少传漏传)

1451000

参数错误: 模板设定参与方类型不匹配,participantId:xxx

(场景:模板设定参与方为个人,传参指定为企业)

1451000

参数错误: 模板存在参与方为发起人本人,不支持平台方发起

1451000

参数错误: 参与方信息无需指定

1451000

参数错误: 参与方信息未指定

(场景:指定参与方未传)

1451000

参数错误: 使用模板指定参与方不存在,participantId:xxxx

1451000

参数错误: 发起人必须为个人账号,xxx

1451000

参数错误: 企业发起方必须为企业,xxx

1451000

参数错误: 个人参与方必须为个人,xxx

1451000

参数错误: 企业参与方经办人必须为个人,xxx

1451000

参数错误: 企业参与方必须为企业,xxx

1451000

参数错误: 抄送人必须为个人,xxx

1451000

参数错误: 企业抄送方必须为企业,xxx

1451056

当前使用的模板中不支持预填填写控件

1451005

附件ID重复:%s

1451009

流程模板数据异常:流程模板拥有者不匹配

(场景:企业B使用企业A模板发起)

1451009

流程模板校验使用权限未通过:企业成员不存在

(场景:非企业成员使用模板发起)

1451009

流程模板校验使用权限未通过:发起方没有该模板的使用权限

场景:企业内成员无使用权限发起)

1451009

模板非启用状态,请先启用此模板

(场景:模板处于停用关闭状态不可以使用)

1451009

模板已被删除,无法使用

(场景:模板已被删除,无法使用模板id不存在或删除)

1451006

用户未授权:%s,%s

1451008

账号不存在或已注销,xxx

1451010

签署方付费模式不支持当前售卖方式,仅组合计费生效

1451010

暂不支持个人发起方付费

1451010

用户未授权: xxx,org_initiate_sign

1451010

用户未授权: xxx,psn_initiate_sign

1451010

用户未授权: xxx,use_org_order

1451010

发起方账号xxx未实名

1451010

签署人账号未注册,signerAccountId:xxx

1451010

签署主体账号未注册,authorizedAccountId:xxx

1451010

企业账户中电子合同份数不足,请购买套餐后再操作

1451010

企业账户中电子合同份数不足,请联系管理员(xxx)购买套餐后再操作

1451011

签署方付费模式不支持当前售卖方式,仅组合计费生效

1451011

暂不支持个人发起方付费

1451011

用户未授权: xxx,org_initiate_sign

1451011

用户未授权: xxx,psn_initiate_sign

1451011

用户未授权: xxx,use_org_order

1451011

发起方账号xxx未实名

1451011

签署人账号未注册,signerAccountId:xxx

1451011

签署主体账号未注册,authorizedAccountId:xxx

1451011

企业账户中电子合同份数不足,请购买套餐后再操作

1451011

企业账户中电子合同份数不足,请联系管理员(xxx)购买套餐后再操作

1451012

控件不属于此模板文件: 控件ID: xxx;文件ID:xxx

1451012

预填写控件不存在:控件ID: xxx;文件ID:xxx

1451012

填写内容不合规: 控件'日期'不符合预设日期格式: yyyy-MM-dd

1451012

填写内容不合规: 控件'数字'不符合预设数字格式:0

1451012

存在不支持预填的控件类型,请核对后重试:控件ID: xxx;文件ID:xxx

获取填写页面链接

POST /v3/sign-flow/{signFlowId}/draft-url

code 错误码

message 错误信息

1451000

参数错误: 未传redirectUrl不允许设置redirectDelayTime

1451000

参数错误: redirectDelayTime只允许0-5

1451000

参数错误: 请传入填写操作人operator

1451000

参数错误: 个人填写方psnId和psnAccount不能同时传值

1451000

参数错误: 客户端类型不正确

1451016

填写流程不存在

1451006

用户未授权: %s,org_initiate_sign

1451054

个人填写方账号未注册,psnId: %s

1451052

用户账户不存在, psnAccount: %s

1451055

当前应用下,签署流程不存在,signFlowId: %S

查询合同拟定和签署流程状态

GET /v3/sign-flow/{signFlowId}/status

code 错误码

message 错误信息

1451001

填写流程不存在

1451006

用户未授权: %s,org_initiate_sign

1451055

当前应用下,签署流程不存在,signFlowId: %s

查询合同拟定详情

GET /v3/sign-flow/{signFlowId}/draft-detail

code 错误码

message 错误信息

1451016

填写流程不存在

1451006

用户未授权: %s,org_initiate_sign

1451001

流程不存在

1451055

当前应用下,签署流程不存在,signFlowId: %s

查询合同拟定流程列表

POST /v3/sign-flow/list

code 错误码

message 错误信息

1451000

参数错误: 开始时间不大于结束时间

1451000

参数错误: 查询时间段需在1年内

1451000

参数错误: 开始时间(流程发起时间)过早,仅能查询近5年发起的流程

1451000

参数错误: 流程状态不合法

1451000

参数错误: 填写操作人psnId和psnAccount不能同时传值

1451000

参数错误: 机构填写方orgId和orgName不能同时传值

1451000

参数错误: 企业发起方id没有传入

1451052

用户账户不存在,psnAccount: %s

1451053

企业账户不存在,orgName: %s

撤销合同拟定

POST /v3/sign-flow/{signFlowId}/rescind

code 错误码

message 错误信息

1451016

填写流程不存在

1451006

用户未授权: %s,org_initiate_sign

1451001

填写流程撤回失败: 流程未在填写状态

1451015

当前应用下,签署流程不存在,signFlowId: %s