跳到主要内容

通过多文件创建合同组签署流程

1. 接口描述

接口请求域名: ess.tencentcloudapi.com 。

此接口(CreateFlowGroupByFiles)可用于通过多个文件创建合同组签署流程。

适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。

注意事项:使用该接口需要先依赖多文件上传接口返回的FileIds。

注:合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称必选类型描述
ActionString公共参数,本接口取值:CreateFlowGroupByFiles。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
FlowGroupNameString合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
FlowGroupInfos.NArray of FlowGroupInfo合同(流程)组的子合同信息,支持2-50个子合同
AgentAgent代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
FlowGroupOptionsFlowGroupOptions合同(流程)组的配置项信息。
其中包括:

  • 是否通知本企业签署方
  • 是否通知其他签署方

3. 输出参数

参数名称类型描述
FlowGroupIdString合同(流程)组的合同组Id
注意:此字段可能返回 null,表示取不到有效值。
FlowIdsArray of String合同(流程)组中子合同列表.
注意:此字段可能返回 null,表示取不到有效值。
ApproversArray of FlowGroupApprovers合同组签署方信息。
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建一个有3份子合同的合同组签署流程(B2B(含自动签署)、B2B、B2C)

  1. 子合同1为B2B合同(Approvers中包含两个ApproverInfo元素);
  2. 子合同1的发起方企业自动签署(ApproverType设置为3,SIGN_SEAL对应签署控件的ComponentValue设置为自动签署使用的印章Id);
  3. 子合同2为普通B2B合同(Approvers中包含两个ApproverInfo元素,且ApproverType都是0);
  4. 子合同3为普通B2C合同(Approvers中包含两个ApproverInfo元素,C端签署人的ApproverType为1)。

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowGroupByFiles
<公共请求参数>

{
"Operator": {
"UserId": "yDwf2UUckps3me1aUuRbyBJvD8CIgM4K"
},
"FlowGroupName": "示例合同组-有3份子合同",
"FlowGroupInfos": [
{
"FileIds": [
"yDwgAUUckp1tbkbgUukJIiCyj7014en1"
],
"FlowName": "子合同1-B2B(发起方企业自动签署)",
"FlowDescription": "子合同1",
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 3,
"OrganizationName": "典子谦示例企业",
"ApproverName": "典子谦",
"ApproverMobile": "18251952320",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 100,
"ComponentHeight": 100,
"ComponentValue": "yDxMjUyKQDN7EkUuO4zjEBpGXvHEACSA"
}
]
},
{
"ApproverName": "张三",
"ApproverType": 0,
"OrganizationName": "张三示例企业",
"ApproverMobile": "18888888888",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 200,
"ComponentHeight": 100
}
]
}
],
"Unordered": true
},
{
"FileIds": [
"yDwgAUUckp1tbkbgUukJIiCyj7014en2"
],
"FlowName": "子合同2-普通B2B",
"FlowDescription": "子合同2",
"FlowType": "示例合同",
"CallbackUrl": "",
"Approvers": [
{
"ApproverType": 0,
"OrganizationName": "典子谦示例企业",
"ApproverName": "典子谦",
"ApproverMobile": "18251952320",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 100,
"ComponentHeight": 100,
"ComponentValue": ""
}
]
},
{
"ApproverType": 0,
"OrganizationName": "李四示例企业",
"ApproverName": "李四",
"ApproverMobile": "15100000000",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 200,
"ComponentHeight": 100
}
]
}
],
"Unordered": true
},
{
"FileIds": [
"yDwgAUUckp1tbkbgUukJIiCyj7014en3"
],
"FlowName": "子合同3-普通B2C",
"Deadline": 0,
"FlowDescription": "子合同3",
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 0,
"OrganizationName": "王五示例企业",
"ApproverName": "王五",
"ApproverMobile": "13700000000",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 100,
"ComponentHeight": 100,
"ComponentValue": ""
}
]
},
{
"ApproverType": "1",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 200,
"ComponentHeight": 100
}
]
}
],
"Unordered": true
}
]
}

输出示例

{
"Response": {
"FlowGroupId": "yDwJ7UUckpk84praUyPWcjISDLsIVxyo",
"FlowIds": [
"yDwJ7UUckpk84prkUyPWcjIufyhLeqjP",
"yDwJ7UUckpk84prtUyPWcjIwX73sJYGC",
"yDwJ7UUckpk84pryUyPWcjI11TGDLwGO"
],
"RequestId": "s1694570527888078574"
}
}

示例2 通过主代子方式创建一个有3份子合同的合同组签署流程(B2B(含自动签署)、B2B、B2C)

  1. 通过主代子方式发起合同(Agent.ProxyOrganizationId设置为子企业的电子签企业Id);
  2. 子合同1为B2B合同(Approvers中包含两个ApproverInfo元素,且ApproverType都是0);
  3. 子合同1的发起方企业自动签署(ApproverType设置为3,SIGN_SEAL对应签署控件的ComponentValue设置为自动签署使用的印章Id);
  4. 子合同2为普通B2B合同(Approvers中包含两个ApproverInfo元素,且ApproverType都是0);
  5. 子合同3为普通B2C合同(Approvers中包含两个ApproverInfo元素,C端签署人的ApproverType为1)。

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowGroupByFiles
<公共请求参数>

{
"Operator": {
"UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
},
"Agent": {
"ProxyOrganizationId": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
},
"FlowGroupName": "示例合同组-3份子合同",
"FlowGroupInfos": [
{
"FileIds": [
"yDwgAUUckp1tbkbgUukJIiCyj7014en1"
],
"FlowName": "子合同1-B2B(发起方企业自动签署)",
"FlowDescription": "子合同1",
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 3,
"OrganizationName": "典子谦示例企业",
"ApproverName": "典子谦",
"ApproverMobile": "18251952320",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 100,
"ComponentHeight": 100,
"ComponentValue": "yDxMjUyKQDN7EkUuO4zjEBpGXvHEACSA"
}
]
},
{
"ApproverName": "张三",
"ApproverType": 0,
"OrganizationName": "张三示例企业",
"ApproverMobile": "18888888888",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 200,
"ComponentHeight": 100
}
]
}
],
"Unordered": true
},
{
"FileIds": [
"yDwgAUUckp1tbkbgUukJIiCyj7014en2"
],
"FlowName": "子合同2-普通B2B",
"FlowDescription": "子合同2",
"FlowType": "示例合同",
"CallbackUrl": "",
"Approvers": [
{
"ApproverType": 0,
"OrganizationName": "典子谦示例企业",
"ApproverName": "典子谦",
"ApproverMobile": "18251952320",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 100,
"ComponentHeight": 100,
"ComponentValue": ""
}
]
},
{
"ApproverType": 0,
"OrganizationName": "李四示例企业",
"ApproverName": "李四",
"ApproverMobile": "15100000000",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 200,
"ComponentHeight": 100
}
]
}
],
"Unordered": true
},
{
"FileIds": [
"yDwgAUUckp1tbkbgUukJIiCyj7014en3"
],
"FlowName": "子合同3-普通B2C",
"Deadline": 0,
"FlowDescription": "子合同3",
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 0,
"OrganizationName": "王五示例企业",
"ApproverName": "王五",
"ApproverMobile": "13700000000",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 100,
"ComponentHeight": 100,
"ComponentValue": ""
}
]
},
{
"ApproverType": "1",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 200,
"ComponentHeight": 100
}
]
}
],
"Unordered": true
}
]
}

输出示例

{
"Response": {
"FlowGroupId": "yDwJ8UUckpk84plbUyPWcjISvuv6WMJx",
"FlowIds": [
"yDwJ8UUckpk84ploUyPWcjIS9KmiX55F",
"yDwJ8UUckpk84plvUyPWcjIxKfGMJ9fF",
"yDwJ8UUckpk84plaUyPWcjIvgnAvfS3H"
],
"RequestId": "s1694572486923868447"
}
}

示例3 创建一个有2份子合同的合同组签署流程(B2B、B2C),并通过FlowGroupOptions控制签署人通知方式

1.子合同1是B2B合同 (Approvers中有两个ApproverInfo元素) 2.子合同2是B2C合同 (Approvers中有两个ApproverInfo元素,C端签署人ApproverType是1) 3.此合同组下所有子合同,C端签署人使用手机号验证校验方式 (FlowGroupOptions.ApproverVerifyType 设置为MobileCheck) 4.此合同组下所有子合同,发起方企业经办人不通知,需要发起方自行通知(FlowGroupOptions.SelfOrganizationApproverNotifyType 设置为none) 5.此合同组下所有子合同,他方企业经办人通过短信通知(FlowGroupOptions.OtherApproverNotifyType 设置为sms)

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowGroupByFiles
<公共请求参数>

{
"Operator": {
"UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
},
"FlowGroupName": "示例合同组-有3份子合同",
"FlowGroupInfos": [
{
"FileIds": [
"yDwgAUUckp1tbkbgUukJIiCyj7014en1"
],
"FlowName": "子合同1-B2B(发起方企业自动签署)",
"FlowDescription": "子合同1",
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 0,
"OrganizationName": "典子谦示例企业",
"ApproverName": "典子谦",
"ApproverMobile": "18251952320",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 100,
"ComponentHeight": 100,
"ComponentValue": "yDxMjUyKQDN7EkUuO4zjEBpGXvHEACSA"
}
]
},
{
"ApproverName": "张三",
"ApproverType": 0,
"OrganizationName": "张三示例企业",
"ApproverMobile": "18888888888",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 200,
"ComponentHeight": 100
}
]
}
],
"Unordered": true
},
{
"FileIds": [
"yDwgAUUckp1tbkbgUukJIiCyj7014en2"
],
"FlowName": "子合同2-普通B2C",
"Deadline": 0,
"FlowDescription": "子合同2",
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 0,
"OrganizationName": "王五示例企业",
"ApproverName": "王五",
"ApproverMobile": "13700000000",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 100,
"ComponentHeight": 100,
"ComponentValue": ""
}
]
},
{
"ApproverType": "1",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 200,
"ComponentHeight": 100
}
]
}
],
"Unordered": true
}
],
"FlowGroupOptions": {
"ApproverVerifyType": "MobileCheck",
"SelfOrganizationApproverNotifyType": "none",
"OtherApproverNotifyType": "sms"
}
}

输出示例

{
"Response": {
"FlowGroupId": "yDwJ7UUckpk84plbUyPWcjISvuv6WMJx",
"FlowIds": [
"yDwJ7UUckpk84ploUyPWcjIS9KmiX55F",
"yDwJ7UUckpk84plvUyPWcjIxKfGMJ9fF",
"yDwJ7UUckpk84plaUyPWcjIvgnAvfS3H"
],
"RequestId": "s1694572486923868447"
}
}

示例4 创建一个有3份子合同的合同组签署流程(B2B、B2B、B2C),指定每个子合同第一方为动态签署方

  1. 子合同1为B2B合同(Approvers中包含两个ApproverInfo元素);
  2. 子合同1、2为普通B2B合同(Approvers中包含两个ApproverInfo元素,且ApproverType都是0);
  3. 子合同3为普通B2C合同(Approvers中包含两个ApproverInfo元素,C端签署人的ApproverType为1)。 4.三份子合同第一方签署方均指定为动态签署方(即不指定具体签署人,FillType=1),可在发起后再进行补充。

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowGroupByFiles
<公共请求参数>

{
"Operator": {
"UserId": "yDwf2UUckps3me1aUuRbyBJvD8CIgM4K"
},
"FlowGroupName": "示例合同组-有3份子合同",
"FlowGroupInfos": [
{
"FileIds": [
"yDwgAUUckp1tbkbgUukJIiCyj7014en1"
],
"FlowName": "子合同1-B2B(发起方企业自动签署)",
"FlowDescription": "子合同1",
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 0,
"ApproverRoleName": "甲方",
"ApproverOption": {
"FillType": 1
},
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 100,
"ComponentHeight": 100,
"ComponentValue": "yDxMjUyKQDN7EkUuO4zjEBpGXvHEACSA"
}
]
},
{
"ApproverName": "张三",
"ApproverType": 0,
"OrganizationName": "张三示例企业",
"ApproverMobile": "18888888888",
"ApproverRoleName": "乙方",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 200,
"ComponentHeight": 100
}
]
}
],
"Unordered": true
},
{
"FileIds": [
"yDwgAUUckp1tbkbgUukJIiCyj7014en2"
],
"FlowName": "子合同2-普通B2B",
"FlowDescription": "子合同2",
"FlowType": "示例合同",
"CallbackUrl": "",
"Approvers": [
{
"ApproverType": 0,
"ApproverRoleName": "甲方",
"ApproverOption": {
"FillType": 1
},
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 100,
"ComponentHeight": 100,
"ComponentValue": ""
}
]
},
{
"ApproverType": 0,
"OrganizationName": "李四示例企业",
"ApproverName": "李四",
"ApproverMobile": "15100000000",
"ApproverRoleName": "乙方",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 200,
"ComponentHeight": 100
}
]
}
],
"Unordered": true
},
{
"FileIds": [
"yDwgAUUckp1tbkbgUukJIiCyj7014en3"
],
"FlowName": "子合同3-普通B2C",
"Deadline": 0,
"FlowDescription": "子合同3",
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 0,
"ApproverRoleName": "甲方",
"ApproverOption": {
"FillType": 1
},
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 100,
"ComponentHeight": 100,
"ComponentValue": ""
}
]
},
{
"ApproverType": "1",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"ApproverRoleName": "乙方",
"SignComponents": [
{
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE",
"ComponentPage": 1,
"ComponentRequired": true,
"ComponentPosX": 100,
"ComponentPosY": 200,
"ComponentHeight": 100
}
]
}
],
"Unordered": true
}
]
}

输出示例

{
"Response": {
"Approvers": [
{
"Approvers": [
{
"ApproverRoleName": "甲方",
"RecipientId": "yDCVHUUnh3kgwiU90l6PyV6AkMyS0Lgx",
"SignId": "yDCVHUUnh3kgwxU90l6PBcCQi6YAeZWy"
},
{
"ApproverRoleName": "乙方",
"RecipientId": "yDCVHUUckpwbqu80UuyXGHSwrgMinnSy",
"SignId": "yDCVHUUckpwbqu8dUuyXGHSxa5F93K42"
}
],
"FlowId": "yDCVHUUnh3kgw9U90l6PzoNCAOlgR7xB"
},
{
"Approvers": [
{
"ApproverRoleName": "甲方",
"RecipientId": "yDCVHUUckpwbqu8lUuyXGHS8vq7fLMsd",
"SignId": "yDCVHUUckpwbquh6UuyXGHSqnN3pYpMd"
},
{
"ApproverRoleName": "乙方",
"RecipientId": "yDCVHUUnh3kgweU90l6Pwb6QiWJk1MYw",
"SignId": "yDCVHUUnh3kgw4U90l6PxzLSFtwfT2XS"
}
],
"FlowId": "yDCVHUUnh3kgw7U90l6PwAC1pTEPzQFy"
},
{
"Approvers": [
{
"ApproverRoleName": "甲方",
"RecipientId": "yDCVHUUckpwbquhfUuyXGHSR8P1F70ug",
"SignId": "yDCVHUUckpwbquhbUuyXGHSRsxjHubmd"
},
{
"ApproverRoleName": "乙方",
"RecipientId": "yDCVHUUckpwbqu8vUuyXGHSBxLkLVZWR",
"SignId": "yDCVHUUckpwbqu8sUuyXGHSw1pO8DoHP"
}
],
"FlowId": "yDCVHUUckpwbquhuUuyXGHS8IdZrFis5"
}
],
"FlowGroupId": "yDCVHUUnh3kgwfU90l6PCbX2FydFwrHu",
"FlowIds": [
"yDCVHUUnh3kgw9U90l6PzoNCAOlgR7xB",
"yDCVHUUnh3kgw7U90l6PwAC1pTEPzQFy",
"yDCVHUUckpwbquhuUuyXGHS8IdZrFis5"
],
"RequestId": "s1711349304019043831"
}
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码描述
FailedOperation操作失败。
FailedOperation.AgeNotAchieveNormalLegal年龄限制无法使用电子签服务,请联系客服咨询处理。
FailedOperation.FlowHasDocument签署流程已有关联文档,请检查参数修改后重试。
FailedOperation.FlowHasNoDocument流程未找到关联的电子文件信息,请检查操作步骤,检查参数,并在修改后重试。
FailedOperation.NoSignReviewPass签署审核未通过,请先完成审核。
FailedOperation.OrganizationExperienceChange企业经营状态与工商局信息不符。
FailedOperation.OrganizationNameChanged企业名称与工商局信息不符。
FailedOperation.OrganizationNameNeedChange企业名称与工商局信息不符,需要超管修改。
FailedOperation.PreViewUrlFail创建签署流程预览链接失败,请稍后重试。
FailedOperation.RequestLimitExceeded请求的次数超过了频率限制,请联系客服处理。
FailedOperation.UserInfoNoMatch用户信息不匹配,请检查后重试。
InternalError内部错误。
InternalError.Db数据库异常。
InternalError.DbConnection数据库连接出错。
InternalError.DbInsert数据库新增记录出错。
InternalError.DependsApi依赖的第三方API返回错误。
InternalError.DependsDb数据库执行错误。
InternalError.JsonMarshalJson序列化失败。
InternalError.PdfPdf错误。
InternalError.Serialize序列化错误。
InternalError.System系统错误,请稍后重试。
InvalidParameter.ApproverType不合法的签署人类型,请检查后重试。
InvalidParameter.CardNumber不合法的证件信息,请检查证件号证件类型是否正确。
InvalidParameter.CardType不合法的证件信息,请检查证件号证件类型是否正确。
InvalidParameter.CcNum不合法的抄送方设置,请联系客服了解抄送设置规则,修改后重试。
InvalidParameter.ClientTokenClientToken不合法请检查。
InvalidParameter.ComponentFileIndex不合法的控件所在文件序号,请检查文件资源与控件的对应关系,并在修改后重试。
InvalidParameter.ComponentPage不合法的控件页码,请与文件资源检查,并在修改后重试。
InvalidParameter.ComponentPosition不合法的控件大小或坐标,请检查控件坐标,大小是否合理,并在修改后重试。
InvalidParameter.ComponentTypeNoMatchValue控件的类型与输入值不匹配,请检查参数修改后重试。
InvalidParameter.ComponentValue不合法的控件内容,请检查控件是否必填,检查控件内容是否正确设置,并在修改后重试。
InvalidParameter.CustomShowMap无效的自定义页卡模板,请检查后重试。
InvalidParameter.EmptyParams参数为空,请检查参数修改后重试。
InvalidParameter.EndPoint不合法的EndPoint,请检查修改后重试。
InvalidParameter.FlowCallbackUrl不合法的签署流程回调链接,请修改后重试。
InvalidParameter.FlowDeadLine不合法的签署流程截止日期,请修改后重试。
InvalidParameter.FlowDescription不合法的签署流程描述,请修改后重试。
InvalidParameter.FlowName不合法的签署流程名称,请修改后重试。
InvalidParameter.FlowType不合法的签署流程类型,请修改后重试。
InvalidParameter.FlowUserData不合法的签署流程用户自定义数据,请修改后重试。
InvalidParameter.FromSource不合法的FromSource,请联系开发,检查后重试。
InvalidParameter.IdCardValidityOverLimit用户个人证件已过期。
InvalidParameter.InvalidChannelChannel不正确。
InvalidParameter.InvalidIdid类型参数不合法,请检查后重试。
InvalidParameter.InvalidMobile手机号码不正确。
InvalidParameter.InvalidName姓名不正确。
InvalidParameter.InvalidOrganizationName组织机构名称不正确。
InvalidParameter.InvalidVerifyChannel实名认证渠道不正确。
InvalidParameter.MissingRequiredComponentValue缺少必填控件的值。
InvalidParameter.Mobile不合法的手机号,请检查后重试。
InvalidParameter.Name不合法的用户名称,请修改后重试。
InvalidParameter.NotifyType不支持的通知类型,请检查并联系客服处理。
InvalidParameter.OrganizationName不合法的企业名称,请修改后重试。
InvalidParameter.ParamError参数错误。
InvalidParameter.PersonAutoSignTag个人静默签Tag未设置,请检查后重试。
InvalidParameter.PreReadTime不合法的阅读时长限制,请联系客服了解阅读时长设置规则,修改后重试。
InvalidParameter.SealId不合法的印章id,请检查印章id是否正确,并在修改后重试。
InvalidParameter.SignComponents签署控件参数不合法,请检查后重试。
InvalidParameter.VerifyChannel不合法的认证渠道,请联系客户了解电子签支持的认证渠道,并在修改后重试。
InvalidParameterValue参数取值错误。
LimitExceeded超过配额限制。
MissingParameter缺少参数错误。
MissingParameter.ApproverMobile缺少签署人手机号,请检查后重试。
MissingParameter.ApproverName缺少签署人姓名,请检查后重试。
MissingParameter.ApproverOrganizationInfo缺少签署人企业信息,请检查后重试。
MissingParameter.ApproverRole缺少签署流程签署人角色信息,请检查修改后重试。
MissingParameter.ApproverSignComponent缺少签署人签署控件配置,请联系客服了解控件传递规则,并在修改后重试。
MissingParameter.Field未找到表单域配置信息,请检查控件传参,检查文件资源配置,并在修改后重试。
MissingParameter.FileNames文件名为空,请检查参数修改后重试。
MissingParameter.FlowApprover缺少签署流程签署人信息,请指定签署人信息后重试。
MissingParameter.FlowId缺少签署流程id,请检查修改后重试。
MissingParameter.KeyWord未找到关键字配置信息,请检查控件传参,检查文件资源配置,并在修改后重试。
MissingParameter.Recipient缺少模板签署人信息,请检查后重试。
MissingParameter.ResourceId缺少文件资源ID,请检查后重试。
MissingParameter.ServerSignSealId缺少静默签印章id,请检查修改后重试。
MissingParameter.SignComponents缺少签署控件参数。
OperationDenied操作被拒绝。
OperationDenied.ApproverNoMatchTemplate签署人设置与模板中签署人配置信息不一致,请检查模板修改参数后重试。
OperationDenied.ApproverRepeat签署人重复,请联系客服了解发起签署流程签署人规则,修改后重试。
OperationDenied.BranchSendFlowToParentNotAllow子公司不能发起本方母体公司的合同。
OperationDenied.CcForbid当前不支持抄送,请联系客服咨询处理。
OperationDenied.CcUserRepeat抄送方存在相同抄送人,请检查修改后重试。
OperationDenied.ErrNoSupportIndividualHasOrganizationName个人签署方不支持设置企业名称,请确认签署人类型后重试。
OperationDenied.FileDeleted文件已被删除,请联系客服处理。
OperationDenied.FileNoMatchResource文件与资源不匹配,请检查文件名与资源id数量以及对应关系,并在修改后重试。
OperationDenied.FlowStatusForbid签署流程状态不正确,请检查后重试。
OperationDenied.Forbid禁止此项操作。
OperationDenied.InvalidApproverAge签署人年龄限制无法使用电子签服务。
OperationDenied.ManyResourceId资源id超过使用上限限制,请联系客服了解规则,并在修改后重试。
OperationDenied.NoIdentityVerify未通过个人实名认证。
OperationDenied.NoLogin用户未登录,请先登录后再操作。
OperationDenied.NoOpenServerSign未开通静默签功能,请联系签署方企业开通后重试。
OperationDenied.NoPermissionUseResource无权限使用文件资源,请检查资源有效性以及资源归属,并在修改后重试。
OperationDenied.NoPermissionUseServerSignSeal无权限使用印章做静默签,请检查印章是否有效,是否有使用权限,并在修改后重试。
OperationDenied.NoQuota企业额度不足,请检查企业额度后处理。
OperationDenied.NoSupportComponentType不支持的控件类型,请联系客服了解支持的控件类型,并在修改后重试。
OperationDenied.NoSupportJumpPage不支持的跳转页,请联系客服了解跳转配置规则,修改后重试。
OperationDenied.OrgUniformSocialCreditCodeErr此社会信用编码未查询到结果,请检查后重试。
OperationDenied.OrganizationNotActivated企业未激活。
OperationDenied.OutQueryLimit查询限频,请先联系客服了解限频策略,稍后重试。
OperationDenied.OverSeaForbid当前不支持境外用户,请联系客服咨询处理。
OperationDenied.PersonHasNoSignature个人名下没用可使用的签名,请联系个人配置签名后重试。
OperationDenied.PersonNoOpenServerSign该用户已关闭或者未开启自动签服务,请检查后重试。
OperationDenied.PersonServerSignForbid拒绝个人静默签,请检查个人静默签签署人,并在修改后重试。
OperationDenied.RequiredComponentNotFill必填控件未设置填写内容,将检查修改后重试。
OperationDenied.ServerSignNoAllowComponent静默签署方不允许有填写控件,请修改模板,修改参数后重试。
OperationDenied.ServerSignNoSupportSignature静默签署不支持手写签名,请配置印章并使用印章重试。
OperationDenied.SubOrgNotJoin子企业暂未加入。
OperationDenied.WhiteListForbid未开通功能白名单,请联系客服处理。
RequestLimitExceeded请求的次数超过了频率限制。
ResourceInUse资源被占用。
ResourceInsufficient资源不足。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在或已删除。
ResourceNotFound.AuthActiveOrganization机构未完成认证激活,请检查并联系客服处理。
ResourceNotFound.Document未找到电子文档信息,请检查后重试。
ResourceNotFound.ErrNotExistRole未获取到用户角色信息,请检查员工角色配置。
ResourceNotFound.Flow签署流程未找到,请检查参数。
ResourceNotFound.FlowApprover签署流程的签署人不存在,请检查后重试。
ResourceNotFound.NotExistDocument电子文档不存在。
ResourceNotFound.NotExistFlow流程不存在。
ResourceNotFound.NotExistResource指定的资源不存在。
ResourceNotFound.NotExistTemplate模板不存在。
ResourceNotFound.Organization机构不存在或者未完成认证,请检查机构信息。
ResourceNotFound.Resource未获取到文件资源,请检查资源是否完成上传,是否有效,并在修改后重试。
ResourceNotFound.SuperAdmin超管信息不存在,请检查企业认证信息。
ResourceNotFound.User用户或者员工信息不存在,请检查参数后重试。
ResourceNotFound.VerifyUser用户或者员工未完成实名认证,请检查参数后重试。
ResourceUnavailable资源不可用。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
UnknownParameter未知参数错误。
UnsupportedOperation操作不支持。
更多开发者交流反馈
购买咨询
4006-808-062
4006-808-062