用PDF文件创建签署流程
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
默认接口请求频率限制:300次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateFlowByFiles。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Operator | 是 | UserInfo | 执行本接口操作的员工信息。使用此接口时,必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
FlowName | 是 | String | 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。 |
Approvers.N | 是 | Array of ApproverInfo | 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。 |
FileIds.N | 是 | Array of String | 本合同流程需包含的PDF文件资源编号列表,通过UploadFiles接口获取PDF文件资源编号。 注: 目前,此接口仅支持单个文件发起。 |
FlowDescription | 否 | String | 合同流程描述信息(可自定义此描述),最大长度1000个字符。 |
FlowType | 否 | String | 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。 |
Components.N | 否 | Array of Component | 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
CcInfos.N | 否 | Array of CcInfo | 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。 |
CcNotifyType | 否 | Integer | 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
|
NeedPreview | 否 | Boolean | 是否为预览模式,取值如下:
|
PreviewType | 否 | Integer | 预览模式下产生的预览链接类型
注: 此参数在NeedPreview 为true时有效 示例值:0 |
Deadline | 否 | Integer | 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。 |
RemindedOn | 否 | Integer | 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。 |
Unordered | 否 | Boolean | 合同流程的签署顺序类型:
|
CustomShowMap | 否 | String | 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为: 合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名} ,则小程序中列表页展示此合同为以下样子合同名称:租房合同 发起方:腾讯公司(张三) 签署方:李四 示例值:合同名称:{合同名称} {发起方企业} {发起方姓名};国家:中国;发起方:{发起方企业};签署方1: {签署方1企业};签署 |
NeedSignReview | 否 | Boolean | 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
注: 此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同 |
UserData | 否 | String | 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。 |
ApproverVerifyType | 否 | String | 指定个人签署方查看合同的校验方式
|
SignBeanTag | 否 | Integer | 签署方签署控件(印章/签名等)的生成方式:
示例值:0 |
Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 |
AutoSignScene | 否 | String | 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
注: 个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。 示例值:E_PRESCRIPTION_AUTO_SIGN |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FlowId | String | 合同流程ID,为32位字符串。 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。 注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。 |
PreviewUrl | String | 合同预览链接URL。 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL 注意:此字段可能返回 null,表示取不到有效值。 |
Approvers | Array of ApproverItem | 签署方信息,如角色ID、角色名称等 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 错误示例:签署人姓名格式传递错误,导致合同创建失败,不扣费用。
- 如果签署人姓名传递了非法的字符串,将会提示错误。
- 合同发起失败,不会生成flowId。
- 对于发起失败的合同,不会进行扣费。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowByFiles
<公共请求参数>
{
"Operator": {
"UserId": "19561039c99fe825a934a132520fde6a"
},
"FlowName": "错误示例合同",
"FlowType": "保证书",
"Approvers": [
{
"ApproverType": 1,
"NotifyType": "NONE",
"ApproverName": "典子谦&",
"ApproverMobile": "13200000000",
"ApproverSignTypes": [
1
],
"SignComponents": [
{
"ComponentPosX": 160,
"ComponentPosY": 260,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE",
"ComponentPage": 1,
"ComponentHeight": 100
}
]
}
],
"FileIds": [
"yDR4yUUgyg1qqlj7UuO4zjES3G9Shoxk"
]
}
输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameter.Name",
"Message": "参数错误,姓名不符合规范,请修改后重试"
},
"RequestId": "s1692325082060040872"
}
}
示例2 创建一份本方企业和个人进行签署合同
- 签署方包括本方企业和个人(Approvers中有两个ApproverInfo元素)。
- 本方企业签署前需要审核(将NeedSignReview设置为true)。
- 本方企业的签署区仅具有一个印章签署控件:印章(SignComponents中有一个Component元素,印章(SIGN_SEAL)使用绝对定位方式,即指定具体ComponentHeight/ComponentWidth/ComponentPosX/ComponentPosY/ComponentPage的方式)。
- C端参与者仅具有一个签名签署控件(SignComponents中仅有一个Component元素,且该元素的ComponentType为SIGN_SIGNATURE,使用绝对定位方式,即指定具体ComponentHeight/ComponentWidth/ComponentPosX/ComponentPosY/ComponentPage的方式)。
- 本流程包含两个抄送人,抄送人可查看合同信息(CcInfos中有两个CcInfo的信息)。
- 指定每个签署方的角色名称。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowByFiles
<公共请求参数>
{
"Operator": {
"UserId": "19561039c99fe825a934a132520fde6a"
},
"Unordered": true,
"FlowName": "B2C 待审核的&带有抄送人",
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 0,
"OrganizationName": "典子谦示例企业",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"ApproverRoleName": "甲方",
"NotifyType": "NONE",
"PreReadTime": 10,
"SignComponents": [
{
"ComponentPosY": 260,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentPosX": 160,
"ComponentHeight": 100
}
]
},
{
"ApproverType": 1,
"NotifyType": "NONE",
"ApproverName": "张三",
"ApproverMobile": "18888888888",
"ApproverRoleName": "乙方",
"SignComponents": [
{
"ComponentPosY": 260,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE",
"ComponentPage": 1,
"ComponentPosX": 160,
"ComponentHeight": 100
}
]
}
],
"CcInfos": [
{
"Name": "李四",
"Mobile": "15100000000"
},
{
"Name": "王五",
"Mobile": "13700000000"
}
],
"FileIds": [
"yDR4yUUgyg1qqlj7UuO4zjES3G9Shoxk"
],
"NeedSignReview": true
}
输出示例
{
"Response": {
"Approvers": [
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmt1u6Um8eW68pzwLGTld6",
"ApproverRoleName": "甲方"
},
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmt1uzUm8eW6CchGlBHFwy",
"ApproverRoleName": "乙方"
}
],
"FlowId": "yDwqoUUckp3bkmc7UuPTimaxVoB5m1iD",
"PreviewUrl": "",
"RequestId": "s1692184714668577966"
}
}
示例3 创建一份涉及本方企业、他方企业和个人签署的三方无序签署合同
- 签署方包括本方企业、他方企业和个人(Approvers中有三个ApproverInfo元素)。
- 本方企业的签署区仅具有一个印章签署控件:印章(SignComponents中有一个Component元素,印章(SIGN_SEAL)使用关键字定位方式,即GenerateMode = KEYWORD)。
- 他方企业参与者仅具有一个印章签署控件(SignComponents中仅有一个Component元素,且该元素的ComponentType为SIGN_SEAL,使用关键字定位方式,即GenerateMode = KEYWORD)。
- C端参与者仅具有一个签名签署控件(SignComponents中仅有一个Component元素,且该元素的ComponentType为SIGN_SIGNATURE,使用关键字定位方式,即GenerateMode = KEYWORD)。
- 本合同为无序签署(Unordered传递为true)。
- 关键字定位PDF的创建方式,请参阅电子签开发者中心 -> 常见问题 -> PDF相关介绍。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowByFiles
<公共请求参数>
{
"Operator": {
"UserId": "19561039c99fe825a934a132520fde6a"
},
"FlowName": "B2B2C关键字无序签署示例合同",
"FlowType": "示例合同",
"Unordered": true,
"Approvers": [
{
"ApproverType": 0,
"OrganizationName": "典子谦示例企业",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"NotifyType": "NONE",
"PreReadTime": 10,
"SignComponents": [
{
"GenerateMode": "KEYWORD",
"ComponentId": "Test",
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPosX": 0,
"ComponentPosY": 0,
"ComponentPage": 0,
"ComponentWidth": 100,
"ComponentHeight": 100,
"OffsetX": 100.5,
"OffsetY": 200.5,
"KeywordOrder": "Positive",
"KeywordPage": 1,
"RelativeLocation": "Middle"
}
]
},
{
"ApproverType": 0,
"OrganizationName": "张三示例企业",
"ApproverName": "张三",
"ApproverMobile": "18888888888",
"NotifyType": "NONE",
"PreReadTime": 10,
"SignComponents": [
{
"GenerateMode": "KEYWORD",
"ComponentId": "Test1",
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPosX": 0,
"ComponentPosY": 0,
"ComponentPage": 0,
"ComponentWidth": 100,
"ComponentHeight": 100,
"OffsetX": 100.5,
"OffsetY": 200.5,
"KeywordOrder": "Positive",
"KeywordPage": 1,
"RelativeLocation": "Middle"
}
]
},
{
"ApproverType": 1,
"NotifyType": "NONE",
"ApproverName": "李四",
"ApproverMobile": "15100000000",
"PreReadTime": 10,
"SignComponents": [
{
"GenerateMode": "KEYWORD",
"ComponentId": "Test2",
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE",
"ComponentPosX": 0,
"ComponentPosY": 0,
"ComponentPage": 0,
"ComponentWidth": 100,
"ComponentHeight": 100,
"OffsetX": 100.5,
"OffsetY": 200.5,
"KeywordOrder": "Positive",
"KeywordPage": 1,
"RelativeLocation": "Middle"
}
]
}
],
"FileIds": [
"yDwqYUUckp39gkfxUu14JJPxaTyM1ltq"
]
}
输出示例
{
"Response": {
"Approvers": [
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmtv3xURxlqRxuNInLC9Kh",
"ApproverRoleName": ""
},
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmtv3uURxlqRxxIBOdNTfT",
"ApproverRoleName": ""
},
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmt17kUm8eW6SG8c7HRoJR",
"ApproverRoleName": ""
}
],
"FlowId": "yDwqoUUckp3bkmmbUuPTimaq7zNEvxoX",
"PreviewUrl": "",
"RequestId": "s1692265794625568498"
}
}
示例4 创建一份涉及本方企业、他方企业和个人签署的三方有序签署合同
- 签署方包括本方企业、他方企业和个人(Approvers中有三个ApproverInfo元素)。
- 本方企业的签署区包含两个签署控件:骑缝章和印章(SignComponents中有两个Component元素,骑缝章(SIGN_PAGING_SEAL)采用绝对定位,即指定具体的ComponentHeight/ComponentWidth/ComponentPosX/ComponentPosY/ComponentPage方式;印章(SIGN_SEAL)使用表单域定位方式,即GenerateMode = FIELD)。
- 他方企业参与者仅具有一个印章签署控件(SignComponents中仅有一个Component元素,且该元素的ComponentType为SIGN_SEAL,使用表单域定位方式,即GenerateMode = FIELD)。
- C端参与者仅具有一个签名签署控件(SignComponents中仅有一个Component元素,且该元素的ComponentType为SIGN_SIGNATURE,使用表单域定位方式,即GenerateMode = FIELD)。
- 本合同为有序签署(Unordered传递为false或不传递)。
- 有关表单域PDF的创建方式,请参阅电子签开发者中心 -> 常见问题 -> PDF相关介绍。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowByFiles
<公共请求参数>
{
"Operator": {
"UserId": "19561039c99fe825a934a132520fde6a"
},
"FlowName": "B2B2C表单域有序签署示例合同",
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 0,
"OrganizationName": "典子谦示例企业",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"NotifyType": "NONE",
"PreReadTime": 10,
"SignComponents": [
{
"GenerateMode": "FIELD",
"ComponentName": "seal",
"ComponentHeight": 0,
"ComponentWidth": 0,
"ComponentPage": 1,
"ComponentPosX": 0,
"ComponentPosY": 0,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL"
},
{
"ComponentPosX": 160,
"ComponentPosY": 260,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_PAGING_SEAL",
"ComponentPage": 1,
"ComponentHeight": 100
}
]
},
{
"ApproverType": 0,
"OrganizationName": "张三示例企业",
"ApproverName": "张三",
"ApproverMobile": "18888888888",
"NotifyType": "NONE",
"PreReadTime": 10,
"SignComponents": [
{
"ComponentHeight": 0,
"ComponentWidth": 0,
"ComponentPage": 1,
"ComponentPosX": 0,
"ComponentPosY": 0,
"GenerateMode": "FIELD",
"ComponentName": "seal2",
"FileIndex": 0,
"ComponentType": "SIGN_SEAL"
}
]
},
{
"ApproverType": 1,
"NotifyType": "NONE",
"ApproverName": "李四",
"ApproverMobile": "15100000000",
"PreReadTime": 10,
"SignComponents": [
{
"ComponentHeight": 0,
"ComponentWidth": 0,
"ComponentPage": 1,
"ComponentPosX": 0,
"ComponentPosY": 0,
"GenerateMode": "FIELD",
"ComponentName": "signature",
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE"
}
]
}
],
"FileIds": [
"yDR4yUUgyg1qqlj7UuO4zjES3G9Shoxk"
]
}
输出示例
{
"Response": {
"Approvers": [
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmtvt0URxlqRxSQ0CRRaG8",
"ApproverRoleName": ""
},
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmtvtgURxlqRxyACZnBnZq",
"ApproverRoleName": ""
},
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmt19bUm8eW68mThldYiee",
"ApproverRoleName": ""
}
],
"FlowId": "yDR4yUUgyg1qh6szUxt1qOK1Jy90khKS",
"PreviewUrl": "",
"RequestId": "s1665674603446404796"
}
}
示例5 创建一份涉及本方企业自动签署和个人签署的B2C合同
- 签署方包括本方企业和个人(在Approvers中包含两个ApproverInfo元素)。
- 本方企业采用自动签署方式(在approver中将approverType设置为3)。
- 在发起合同之前,需要为本方经办人开通并授权自动签署功能(登录腾讯电子签控制台 -> 更多能力 -> 企业设置 -> 拓展服务 -> 企业自动签署),详见企业自动签署开通参考文档
- 自动签署方的签署人默认为发起方。
- 本方企业的签署区仅包含一个印章签署控件:印章(在SignComponents中包含一个Component元素,印章(SIGN_SEAL)采用绝对定位方式,即指定具体的ComponentHeight/ComponentWidth/ComponentPosX/ComponentPosY/ComponentPage)。
- 本方企业的印章控件必须指定印章(ComponentValue必须指定当前员工已经授权的印章Id,可登录腾讯电子签控制台 -> 印章 -> 印章中心 选择某一个印章,在页面上显示为印章ID)。
- C端参与者仅包含一个签名签署控件(在SignComponents中仅包含一个Component元素,且该元素的ComponentType为SIGN_SIGNATURE,采用绝对定位方式,即指定具体的ComponentHeight/ComponentWidth/ComponentPosX/ComponentPosY/ComponentPage)。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowByFiles
<公共请求参数>
{
"Operator": {
"UserId": "19561039c99fe825a934a132520fde6a"
},
"FlowName": "静默签署 & B2C合同",
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 3,
"OrganizationName": "典子谦示例企业",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"NotifyType": "NONE",
"PreReadTime": 10,
"SignComponents": [
{
"ComponentPosY": 260,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentValue": "yDxMjUyKQDN7EkUuO4zjEBpGXvHEACSA",
"ComponentPage": 1,
"ComponentPosX": 160,
"ComponentHeight": 100
}
]
},
{
"ApproverType": 1,
"NotifyType": "NONE",
"ApproverName": "李四",
"ApproverMobile": "15100000000",
"PreReadTime": 10,
"SignComponents": [
{
"ComponentPosY": 260,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE",
"ComponentPage": 1,
"ComponentPosX": 160,
"ComponentHeight": 100
}
]
}
],
"FileIds": [
"yDwqYUUckp39gkfxUu14JJPxaTyM1ltq"
]
}
输出示例
{
"Response": {
"FlowId": "yDwqoUUckp3bkzgpUuPTimaSDVz2ukqv",
"PreviewUrl": "",
"RequestId": "s1692183667030779528"
}
}
示例6 创建一份签署方拖拽签署区域的合同
- 签署方包括本方企业、他方企业和个人(Approvers中有三个ApproverInfo元素)。
- 所有签署方企业都不包允许有签署控件。
- 设置当前流程为可拖拽(SignBeanTag)。
- 本合同为无序签署(Unordered传递为true)。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowByFiles
<公共请求参数>
{
"Operator": {
"UserId": "19561039c99fe825a934a132520fde6a"
},
"Unordered": true,
"FlowName": "签署时拖拽签署控件合同",
"SignBeanTag": 1,
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 0,
"OrganizationName": "典子谦示例企业",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"NotifyType": "NONE",
"PreReadTime": 10
},
{
"ApproverType": 0,
"OrganizationName": "张三示例企业",
"ApproverName": "张三",
"ApproverMobile": "18888888888",
"NotifyType": "NONE",
"PreReadTime": 10
},
{
"ApproverType": 1,
"NotifyType": "NONE",
"ApproverName": "李四",
"ApproverMobile": "15100000000",
"PreReadTime": 10
}
],
"FileIds": [
"yDR4yUUgyg1qqlj7UuO4zjES3G9Shoxk"
]
}
输出示例
{
"Response": {
"Approvers": [
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmtvyqURxlqRxRRQF8HT1m",
"ApproverRoleName": ""
},
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmtvyhURxlqRxSEfd0ag4h",
"ApproverRoleName": ""
},
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmt1ffUm8eW6u0kLIxrZpw",
"ApproverRoleName": ""
}
],
"FlowId": "yDwqoUUckp3bkmc7UuPTimaxVoB5m1iD",
"PreviewUrl": "",
"RequestId": "s1692184714668577966"
}
}
示例7 创建仅有个人C端签署的合同,进行预览,不发起
- 只有一个个人C端参与人(Approvers中仅有一个ApproverInfo元素)。
- 发起时,配置两个发起方填写文本控件(Components中Component元素Type为Text,并使用绝对定位方式,即指定具体ComponentHeight/ComponentWidth/ComponentPosX/ComponentPosY/ComponentPage的方式)。
- 通过绝对定位指定签署区(SignComponents中Component元素指定具体ComponentHeight/ComponentWidth/ComponentPosX/ComponentPosY/ComponentPage的方式)。
- C端参与人仅具有一个签名签署控件(SignComponents中仅有一个Component元素,且该元素的ComponentType为SIGN_SIGNATURE)。
- 文件发起时,设置NeedPreview为1,当PreviewType设置为1时,以文件链接方式返回预览链接(即打开链接会自动进行下载)。
- 仅返回预览链接,不返回合同ID(flowId),仅用于预览。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowByFiles
<公共请求参数>
{
"Operator": {
"UserId": "19561039c99fe825a934a132520fde6a"
},
"Unordered": true,
"Components": [
{
"ComponentPosY": 260,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "TEXT",
"ComponentValue": "典子谦",
"ComponentPage": 1,
"ComponentPosX": 160,
"ComponentHeight": 100
},
{
"ComponentPosY": 360,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "TEXT",
"ComponentValue": "典子谦",
"ComponentPage": 1,
"ComponentPosX": 160,
"ComponentHeight": 100
}
],
"FlowName": "单C合同预览",
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 1,
"NotifyType": "NONE",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"SignComponents": [
{
"ComponentPosY": 260,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE",
"ComponentPage": 1,
"ComponentPosX": 160,
"ComponentHeight": 100
}
]
}
],
"FileIds": [
"yDR4yUUgyg1qqlj7UuO4zjES3G9Shoxk"
],
"NeedPreview": true,
"PreviewType": 1
}
输出示例
{
"Response": {
"FlowId": "",
"PreviewUrl": "https://test.ess.tencent.cn/document-url-preview?channel=PROXYCHANNEL&scene=SINGLEPAGE&code=yDwqoUUckp3bkmmlUuPTimaSa2YKny&codeType=QUICK&businessType=RESOURCE&businessId=yDwqcUUckp39ix54URyS6kCwo8MdKEon",
"RequestId": "s1692272754129210855"
}
}
示例8 创建只有个人C端签署, 签署人需要人脸校验认证的合同流程
- 只有一个个人C端参与人 (Approvers只有一个ApproverInfo元素)
- 签署区的指定通过绝对定位表达 (SignComponents中Component元素指定具体ComponentHeight/ComponentWidth/ComponentPosX/ComponentPosY/ComponentPage的方式)
- C端参与人只有一个签名签署控件(SignComponents只有一个Component元素, 且这个元素的ComponentType是SIGN_SIGNATURE)
- C端签署人需要人脸校验来签署合同 (ApproverSignTypes属性设置成[1]表示只能通过人脸识别校验来签署合同)
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowByFiles
<公共请求参数>
{
"Operator": {
"UserId": "19561039c99fe825a934a132520fde6a"
},
"FlowName": "单个个人签署方合同示例",
"FlowType": "保证书",
"Approvers": [
{
"ApproverType": 1,
"NotifyType": "NONE",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"ApproverSignTypes": [
1
],
"SignComponents": [
{
"ComponentPosX": 160,
"ComponentPosY": 260,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE",
"ComponentPage": 1,
"ComponentHeight": 100
}
]
}
],
"FileIds": [
"yDR4yUUgyg1qqlj7UuO4zjES3G9Shoxk"
]
}
输出示例
{
"Response": {
"Approvers": [
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmo432UunP4DaCo2sOe2oP",
"ApproverRoleName": ""
}
],
"FlowId": "yDRsDUUgyg1aczxtUuNAW8Cx4WsAiEB5",
"PreviewUrl": "",
"RequestId": "43b9474a-c909-4d89-aa7b-3632f02fa8a4"
}
}
示例9 处方单场景
- 处方单场景的"典子谦"医生需要自动签(典子谦参与人的ApproverType设置成7, 并且AutoSignScene设置成E_PRESCRIPTION_AUTO_SIGN表明是处方单场景)
- 处方单的患者张三需要手工签署(张三参与人的ApproverType设置成1)
- 双方签署方的签署控件都是通过关键字生成(典子谦签署区GenerateMode设置成KEYWORD并且ComponentId设置成关键字"处方医生", 张三签署区GenerateMode设置成KEYWORD并且ComponentId设置成关键字"患者签名" )
- 不给合同签署方发送短信 (NotifyType设置成NONE)
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowByFiles
<公共请求参数>
{
"Approvers": [
{
"ApproverIdCardNumber": "620000198802020000",
"ApproverIdCardType": "ID_CARD",
"ApproverMobile": "13200000000",
"ApproverName": "典子谦",
"ApproverType": 7,
"NotifyType": "NONE",
"SignComponents": [
{
"ComponentHeight": 100,
"ComponentId": "处方医生",
"ComponentPage": 1,
"ComponentType": "SIGN_SIGNATURE",
"ComponentValue": "",
"ComponentWidth": 200,
"FileIndex": 0,
"ComponentPosX": 0,
"ComponentPosY": 0,
"GenerateMode": "KEYWORD",
"OffsetX": 80
}
]
},
{
"ApproverIdCardNumber": "37000019890303000X",
"ApproverIdCardType": "ID_CARD",
"ApproverMobile": "18888888888",
"ApproverName": "张三",
"NotifyType": "NONE",
"ApproverType": 1,
"SignComponents": [
{
"ComponentHeight": 100,
"ComponentId": "患者签名",
"ComponentPage": 1,
"ComponentType": "SIGN_SIGNATURE",
"ComponentValue": "",
"ComponentWidth": 200,
"FileIndex": 0,
"GenerateMode": "KEYWORD",
"OffsetX": 80,
"ComponentPosX": 0,
"ComponentPosY": 0
}
]
}
],
"Unordered": true,
"AutoSignScene": "E_PRESCRIPTION_AUTO_SIGN",
"FileIds": [
"yDwqpUUckp3yptnhUxknKKxRmjIJ7ZHf"
],
"FlowName": "处方87235号",
"Operator": {
"UserId": "19561039c99fe825a934a132520fde6a"
}
}
输出示例
{
"Response": {
"Approvers": [
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmo432UunP4DaCo2sOe2oP",
"ApproverRoleName": ""
},
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmo43jUunP4DaSlfnawIyd",
"ApproverRoleName": ""
}
],
"FlowId": "yDRsDUUgyg1aczxtUuNAW8Cx4WsAiEB5",
"PreviewUrl": "",
"RequestId": "43b9474a-c909-4d89-aa7b-3632f02fa8a4"
}
}
示例10 集团企业代表子公司创建仅具有个人C端签署的合同流程,签署人可选择人脸验证、密码验证或短信验证码验证
- 只有一个个人C端参与者(Approvers中仅有一个ApproverInfo元素)。
- 通过绝对定位来指定签署区域(SignComponents中的Component元素指定具体的ComponentHeight/ComponentWidth/ComponentPosX/ComponentPosY/ComponentPage方式)。
- C端参与者只有一个签名签署控件(SignComponents中仅有一个Component元素,且该元素的ComponentType为SIGN_SIGNATURE)。
- C端签署人需进行人脸验证以签署合同(将ApproverSignTypes属性设置为[1,2,3],表示可选择人脸识别验证、密码验证或短信验证码验证来签署合同)。
- 集团企业代表子公司发送合同(在agent中,将ProxyOrganizationId设置为子公司的organizationId,可在腾讯系电子签登录后的组织管理 -> 集团组织管理 -> 成员企业列表中找到企业id)。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowByFiles
<公共请求参数>
{
"Operator": {
"UserId": "19561039c99fe825a934a132520fde6a"
},
"Agent": {
"ProxyOrganizationId": "yDwFdUUckpsvm3ciUyVYxhuSAkZziLk7"
},
"FlowName": "主代子单个个人签署方合同示例",
"FlowType": "保证书",
"Approvers": [
{
"ApproverType": 1,
"NotifyType": "NONE",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"ApproverSignTypes": [
1
],
"SignComponents": [
{
"ComponentPosX": 160,
"ComponentPosY": 260,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE",
"ComponentPage": 1,
"ComponentHeight": 100
},
{
"ComponentPosX": 160,
"ComponentPosY": 360,
"ComponentWidth": 50,
"ComponentHeight": 50,
"FileIndex": 0,
"ComponentType": "SIGN_DATE",
"ComponentPage": 1
}
]
}
],
"FileIds": [
"yDR4yUUgyg1qqlj7UuO4zjES3G9Shoxk"
]
}
输出示例
{
"Response": {
"Approvers": [
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmo432UunP4DaCo2sOe2oP",
"ApproverRoleName": ""
}
],
"FlowId": "yDR4yUUgyg1qh6szUxt1qOK1Jy90khKS",
"PreviewUrl": "",
"RequestId": "s1665674603446404796"
}
}
示例11 发起合同后添加签署区-指定签署控件和印章的无序签署示例合同
- 签署方包括本方企业、他方企业和个人(Approvers中有三个ApproverInfo元素)。
- 允许签署方在签署时自行添加签署控件,可以拖动位置和控制数量。(SignBeanTag 设置为1)
- 明确规定本方企业在签署时可以添加骑缝章控件(SIGN_PAGING_SEAL)、印章控件(SIGN_SEAL)、和法人控件(SIGN_LEGAL_PERSON_SEAL),并且限制了骑缝章控件和印章控件可用的印章ID列表。
- 明确规定他方企业在签署时必须使用印章控件(SIGN_SEAL)。
- 明确规定个人签署方在签署时必须使用签名控件(SIGN_SIGNATURE),并且使用系统签名(SYSTEM_ESIGN)。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowByFiles
<公共请求参数>
{
"Operator": {
"UserId": "19561039c99fe825a934a132520fde6a"
},
"FlowName": "发起合同后添加签署区-指定签署控件和印章的无序签署示例合同",
"FlowType": "示例合同",
"Unordered": true,
"SignBeanTag": 1,
"Approvers": [
{
"ApproverType": 0,
"OrganizationName": "典子谦示例企业",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"PreReadTime": 10,
"AddSignComponentsLimits": [
{
"ComponentType": "SIGN_SEAL",
"ComponentValue": [
"yDwJCUUckpk7t9yyUuXF6wL8KMm3yXcX",
"yDRRuUUgygjvznc7UuO5sjES5RaqSnyn"
]
},
{
"ComponentType": "SIGN_PAGING_SEAL",
"ComponentValue": [
"yDwJCUUckpk7t9yyUuXF6wL8KMm3yXcX",
"yDRRuUU2qyjvspleUuO6zjE1EkGzMK1A"
]
},
{
"ComponentType": "SIGN_LEGAL_PERSON_SEAL"
}
]
},
{
"ApproverType": 0,
"OrganizationName": "张三示例企业",
"ApproverName": "张三",
"ApproverMobile": "18888888888",
"PreReadTime": 10,
"AddSignComponentsLimits": [
{
"ComponentType": "SIGN_SEAL"
}
]
},
{
"ApproverType": 1,
"ApproverName": "李四",
"ApproverMobile": "15100000000",
"PreReadTime": 10,
"AddSignComponentsLimits": [
{
"ComponentType": "SIGN_SIGNATURE",
"ComponentValue": [
"SYSTEM_ESIGN"
]
}
]
}
],
"FileIds": [
"yDwqYUUckp93gkfxUu14JJPxaTy13dtq"
]
}
输出示例
{
"Response": {
"FlowId": "yDJJPxaTy13dtqwqYUUckp93gkfxUu14",
"PreviewUrl": "",
"RequestId": "s1674414304627348115"
}
}
示例12 标书场景下,需要创建一份本方企业和个人签署的标书文件,要求本方企业的印章控件需要在每一页都进行盖章。
- 签署方包括本方企业和个人(Approvers中有两个ApproverInfo元素)。
- 本方企业的签署区仅具有一个印章签署控件:印章(SignComponents中有一个Component元素,印章(SIGN_SEAL)使用绝对定位方式,即指定具体ComponentHeight/ComponentWidth/ComponentPosX/ComponentPosY/ComponentPage的方式)。
- 本方企业的印章签署区需要在所有的页面上面进行加盖,即设置"ComponentExtra":"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}",
- C端参与者仅具有一个签名签署控件(SignComponents中仅有一个Component元素,且该元素的ComponentType为SIGN_SIGNATURE,使用绝对定位方式,即指定具体ComponentHeight/ComponentWidth/ComponentPosX/ComponentPosY/ComponentPage的方式)。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowByFiles
<公共请求参数>
{
"Operator": {
"UserId": "19561039c99fe825a934a132520fde6a"
},
"FlowName": "标书文件合同示例",
"FlowType": "示例合同",
"Approvers": [
{
"ApproverType": 0,
"OrganizationName": "典子谦示例企业",
"ApproverName": "典子谦",
"ApproverMobile": "13200000000",
"SignComponents": [
{
"ComponentPosY": 360,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SEAL",
"ComponentPage": 1,
"ComponentPosX": 60,
"ComponentHeight": 100,
"ComponentExtra": "{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}"
}
]
},
{
"ApproverType": 1,
"ApproverName": "张三",
"ApproverMobile": "18888888888",
"SignComponents": [
{
"ComponentPosY": 260,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE",
"ComponentPage": 1,
"ComponentPosX": 160,
"ComponentHeight": 100
}
]
}
],
"FileIds": [
"yDR4yUUgyg1qqlj7UuO4zjES3G9Shoxk"
]
}
输出示例
{
"Response": {
"FlowId": "yDwFkUUckpstin4sUuZjBEY5Ia2XB7sz",
"PreviewUrl": "",
"RequestId": "s1665674603446404796"
}
}
示例13 创建含有动态签署人流程,签署方不指定具体的签署人
创建一个B2C流程,两方签署方不指定具体的签署人
注:
1.签署人相关信息为空,如:姓名、手机号码等
2.FillType需传值为1,表示为动态签署人(不确定具体的签署人),需后续进行补充。
3.需保留对应的角色编号,即RecipientId,后续补充具体的签署人时需指定对应的RecipientId
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowByFiles
<公共请求参数>
{
"Operator": {
"UserId": "19561039c99fe825a934a132520fde6a"
},
"Agent": {
"ProxyOrganizationId": "yDwFdUUckpsvm3ciUyVYxhuSAkZziLk7"
},
"FlowName": "发起动态签署人合同示例",
"FlowType": "合同",
"Approvers": [
{
"ApproverType": 1,
"ApproverName": "",
"ApproverMobile": "",
"NotifyType": "NONE",
"ApproverSignTypes": [
1
],
"ApproverRoleName": "甲方",
"ApproverOption": {
"FillType": 1
},
"SignComponents": [
{
"ComponentPosX": 160,
"ComponentPosY": 260,
"ComponentWidth": 100,
"FileIndex": 0,
"ComponentType": "SIGN_SIGNATURE",
"ComponentPage": 1,
"ComponentHeight": 100
},
{
"ComponentPosX": 160,
"ComponentPosY": 360,
"ComponentWidth": 50,
"ComponentHeight": 50,
"FileIndex": 0,
"ComponentType": "SIGN_DATE",
"ComponentPage": 1
}
]
}
],
"FileIds": [
"yDR4yUUgyg1qqlj7UuO4zjES3G9Shoxk"
]
}
输出示例
{
"Response": {
"FlowId": "yDR4yUUgyg1qh6szUxt1qOK1Jy90khKS",
"PreviewUrl": "",
"Approvers": [
{
"SignId": "",
"RecipientId": "yDw7hUUckpkmo432UunP4DaCo2sOe2oP",
"ApproverRoleName": "甲方"
}
],
"RequestId": "s1665674603446404796"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.AgeNotAchieveNormalLegal | 年龄限制无法使用电子签服务,请联系客服咨询处理。 |
FailedOperation.FlowHasDocument | 签署流程已有关联文档,请检查参数修改后重试。 |
FailedOperation.FlowHasNoDocument | 流程未找到关联的电子文件信息,请检查操作步骤,检查参数,并在修改后重试。 |
FailedOperation.NoSignReviewPass | 签署审核未通过,请先完成审核。 |
FailedOperation.OrganizationExperienceChange | 企业经营状态与工商局信息不符。 |
FailedOperation.OrganizationNameChanged | 企业名称与工商局信息不符。 |
FailedOperation.OrganizationNameNeedChange | 企业名称与工商局信息不符,需要超管修改。 |
FailedOperation.PreViewUrlFail | 创建签署流程预览链接失败,请稍后重试。 |
FailedOperation.RequestLimitExceeded | 请求的次数超过了频率限制,请联系客服处理。 |
FailedOperation.UserInfoNoMatch | 用户信息不匹配,请检查后重试。 |
InternalError | 内部错误。 |
InternalError.Api | 第三方接口失败。 |
InternalError.Db | 数据库异常。 |
InternalError.DbConnection | 数据库连接出错。 |
InternalError.DbInsert | 数据库新增记录出错。 |
InternalError.DependsApi | 依赖的第三方API返回错误。 |
InternalError.DependsDb | 数据库执行错误。 |
InternalError.JsonMarshal | Json序列化失败。 |
InternalError.Pdf | Pdf错误。 |
InternalError.Serialize | 序列化错误。 |
InternalError.System | 系统错误,请稍后重试。 |
InvalidParameter.ApproverType | 不合法的签署人类型,请检查后重试。 |
InvalidParameter.CardNumber | 不合法的证件信息,请检查证件号证件类型是否正确。 |
InvalidParameter.CardType | 不合法的证件信息,请检查证件号证件类型是否正确。 |
InvalidParameter.CcNum | 不合法的抄送方设置,请联系客服了解抄送设置规则,修改后重试。 |
InvalidParameter.ClientToken | ClientToken不合法请检查。 |
InvalidParameter.ComponentFileIndex | 不合法的控件所在文件序号,请检查文件资源与控件的对应关系,并在修改后重试。 |
InvalidParameter.ComponentPage | 不合法的控件页码,请与文件资源检查,并在修改后重试。 |
InvalidParameter.ComponentPosition | 不合法的控件大小或坐标,请检查控件坐标,大小是否合理,并在修改后重试。 |
InvalidParameter.ComponentTypeNoMatchValue | 控件的类型与输入值不匹配,请检查参数修改后重试。 |
InvalidParameter.ComponentValue | 不合法的控件内容,请检查控件是否必填,检查控件内容是否正确设置,并在修改后重试。 |
InvalidParameter.CustomShowMap | 无效的自定义页卡模板,请检查后重试。 |
InvalidParameter.DataNotFound | 数据不存在。 |
InvalidParameter.EmptyParams | 参数为空,请检查参数修改后重试。 |
InvalidParameter.EndPoint | 不合法的EndPoint,请检查修改后重试。 |
InvalidParameter.FlowCallbackUrl | 不合法的签署流程回调链接,请修改后重试。 |
InvalidParameter.FlowDeadLine | 不合法的签署流程截止日期,请修改后重试。 |
InvalidParameter.FlowDescription | 不合法的签署流程描述,请修改后重试。 |
InvalidParameter.FlowName | 不合法的签署流程名称,请修改后重试。 |
InvalidParameter.FlowType | 不合法的签署流程类型,请修改后重试。 |
InvalidParameter.FlowUserData | 不合法的签署流程用户自定义数据,请修改后重试。 |
InvalidParameter.FromSource | 不合法的FromSource,请联系开发,检查后重试。 |
InvalidParameter.IdCardValidityOverLimit | 用户个人证件已过期。 |
InvalidParameter.InvalidChannel | Channel不正确。 |
InvalidParameter.InvalidId | id类型参数不合法,请检查后重试。 |
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.NoApproverMobileCheckPermission | 没有手机号查看的权限 |
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 | 操作不支持。 |