通过多模板创建合同组签署流程
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
接口(ChannelCreateFlowGroupByTemplates)用于通过多模板创建合同组签署流程。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ChannelCreateFlowGroupByTemplates。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。 |
FlowInfos.N | 是 | Array of FlowInfo | 每个子合同的发起所需的信息,数量限制2-50(合同组暂不支持抄送功能) |
FlowGroupName | 是 | String | 合同组名称,长度不超过200个字符 示例值:"xxx" |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FlowGroupId | String | 合同组ID 示例值:xxx |
FlowIds | Array of String | 子合同ID列表 示例值:["xx","yy"] |
TaskInfos | Array of TaskInfo | 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组; 如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情; |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 通过多模板创建合同组签署流程
通过多模板创建合同组签署流程
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateFlowGroupByTemplates
<公共请求参数>
{
"Agent": {
"ProxyOrganizationOpenId": "test",
"ProxyOperator": {
"OpenId": "test"
},
"AppId": "test"
},
"FlowGroupName": "testx",
"FlowInfos": [
{
"FlowName": "testx",
"TemplateId": "testx",
"FlowDescription": "testx",
"Deadline": 1604910797,
"CallbackUrl": "testx",
"FormFields": [
{
"ComponentName": "testx",
"ComponentValue": "testx"
}
],
"FlowApprovers": [
{
"ApproverType": "PERSON",
"Name": "testx",
"Mobile": "testx",
"RecipientId": "testx"
},
{
"ApproverType": "ORGANIZATION",
"OpenId": "testx",
"OrganizationOpenId": "testx",
"OrganizationName": "testx",
"RecipientId": "testx"
}
]
}
]
}
输出示例
{
"Response": {
"FlowGroupId": "test",
"FlowIds": [
"test"
],
"TaskInfos": [
{
"TaskId": "test",
"TaskStatus": "test"
}
],
"RequestId": "test"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.Db | 数据库错误。 |
InternalError.Decryption | 解密错误。 |
InternalError.Encryption | 加密错误。 |
InternalError.GenerateId | 生成唯一ID错误。 |
InternalError.System | 系统错误。 |
InternalError.ThirdParty | 第三方错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.Application | 应用号不存在。 |
InvalidParameter.ApproverVerifyType | ApproverVerifyType参数值非法 |
InvalidParameter.BizApproverAlreadyExists | 重复添加签署人。 |
InvalidParameter.DataNotFound | 数据不存在。 |
InvalidParameter.FlowInfos | 参数错误,FlowInfos非法,请修改后重试。 |
InvalidParameter.MissingRequiredParameterValue | 缺少必填参数的值。 |
InvalidParameter.Mobile | 手机号码不正确。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.CreateFlowNum | 超出流程创建数量限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.NoIdentityVerify | 未通过个人实名。 |
OperationDenied.UserNotInOrganization | 用户不归属于当前企业,无法操作,请检查后重试。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Application | 应用号不存在。 |
ResourceNotFound.Template | 模板不存在。 |
ResourceNotFound.User | 用户信息不存在。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |