通过多文件创建合同组签署流程
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
接口(ChannelCreateFlowGroupByFiles)用于通过多文件创建合同组签署流程。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ChannelCreateFlowGroupByFiles。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
FlowFileInfos.N | 是 | Array of FlowFileInfo | 每个子合同的发起所需的信息,数量限制2-50 |
FlowGroupName | 是 | String | 合同组名称,长度不超过200个字符 示例值:"xxx" |
Agent | 否 | Agent | 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 |
ApproverVerifyType | 否 | String | 签署人校验方式 VerifyCheck: 人脸识别(默认) MobileCheck:手机号验证 参数说明:若选择后者,未实名的个人签署方查看合同时,无需进行人脸识别实名认证(但签署合同时仍然需要人脸实名),该能力仅适用于个人签署方。 |
FlowGroupOptions | 否 | FlowGroupOptions | 合同组的配置项信息包括:在合同组签署过程中,是否需要对每个子合同进行独立的意愿确认。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FlowGroupId | String | 合同组ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxx |
FlowIds | Array of String | 子合同ID列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxx |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 通过多文件创建合同组签署流程
通过多文件创建合同组签署流程
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateFlowGroupByFiles
<公共请求参数>
{
"Agent": {
"ProxyOrganizationOpenId": "test",
"ProxyOperator": {
"OpenId": "test"
},
"AppId": "test"
},
"FlowGroupName": "testx",
"ApproverVerifyType": "VerifyCheck",
"FlowFileInfos": [
{
"FlowName": "",
"FlowApprovers": [
{
"ApproverType": "testx",
"OrganizationName": "testx",
"OrganizationOpenId": "testx",
"OpenId": "testx",
"SignComponents": [
{
"GenerateMode": "testx",
"ComponentName": "testx",
"FileIndex": 0,
"ComponentType": "testx"
},
{
"GenerateMode": "testx",
"ComponentName": "testx",
"FileIndex": 0,
"ComponentType": "testx"
}
]
}
],
"FileIds": [
"testx"
]
}
]
}
输出示例
{
"Response": {
"FlowGroupId": "test",
"FlowIds": [
"test",
"test"
],
"RequestId": "test"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.AgeNotAchieveNormalLegal | 签署人未达到合法年龄。 |
InternalError | 内部错误。 |
InternalError.Db | 数据库错误。 |
InternalError.DbConnection | 数据库连接出错。 |
InternalError.Decryption | 解密错误。 |
InternalError.Encryption | 加密错误。 |
InternalError.GenerateId | 生成唯一ID错误。 |
InternalError.System | 系统错误。 |
InternalError.ThirdParty | 第三方错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.Application | 应用号不存在。 |
InvalidParameter.ApproverType | 参数错误,不合法的签署人类型,请修改后重试。 |
InvalidParameter.ApproverVerifyType | ApproverVerifyType参数值非法 |
InvalidParameter.BizApproverAlreadyExists | 重复添加签署人。 |
InvalidParameter.CardType | 证件类型错误。 |
InvalidParameter.CustomShowMap | 参数错误,无效的自定义页卡模板,仅支持{合同名称}{发起方姓名}{发起方企业}{签署方N姓名}{签署方N企业},请修改后重试。 |
InvalidParameter.CustomerData | 参数错误,UserData长度非法,请修改后重试。 |
InvalidParameter.DataNotFound | 数据不存在。 |
InvalidParameter.FlowApproverInfos | 参数错误,不合法的备选签署人数量,请检查后重试。 |
InvalidParameter.FlowApprovers | 参数错误,参与者数量不能为空且不能超过数量限制,请修改后重试。 |
InvalidParameter.FlowCallbackUrl | 参数错误,不合法的签署流程回调链接,请修改后重试。 |
InvalidParameter.FlowDeadLine | 参数错误,不合法的签署流程截止日期,请修改后重试。 |
InvalidParameter.FlowDescription | 参数错误,不合法的签署流程描述,请修改后重试。 |
InvalidParameter.FlowFileIds | 参数错误,目前仅支持单个文件发起,请修改后重试。 |
InvalidParameter.FlowName | 参数错误,不合法的签署流程名称,请修改后重试。 |
InvalidParameter.FlowType | 参数错误,不合法的FlowType,请修改后重试。 |
InvalidParameter.Name | 姓名不符合要求。 |
InvalidParameter.NonsupportMobile | 不支持的手机号。 |
InvalidParameter.OrganizationName | 企业名称不合法。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameter.SignComponentType | 参数错误,不合法的签署控件类型,请修改后重试。 |
InvalidParameter.Unordered | 参数错误,不合法的签署顺序,请检查后重试。 |
InvalidParameter.UnsupportedComponentType | 参数错误,不支持的控件类型,请检查后重试。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
MissingParameter.MissComponentName | 缺少控件名称参数,请检查后重试。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.ByFilesServerSignForbid | 文件发起静默签未开通白名单。 |
OperationDenied.ErrNoResourceAccess | 无资源访问权限。 |
OperationDenied.InvalidApproverAge | 签署人未达到合法年龄。 |
OperationDenied.NoApproverMobileCheckPermission | 企业暂未开通手机号验证身份的服务,请在企业中心开通再使用 |
OperationDenied.NoIdentityVerify | 未通过个人实名。 |
OperationDenied.NoQuota | 流程配额不足。 |
OperationDenied.OverseaAbilityNotOpen | 当前企业员工没有开通境外签署能力。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Application | 应用号不存在。 |
ResourceNotFound.Resource | 资源不存在。 |
ResourceNotFound.Seal | 印章不存在,请检查后重试。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |