跳到主要内容

使用模板创建签署流程

1. 接口描述​

接口请求域名： essbasic.tencentcloudapi.com 。

接口（CreateFlowsByTemplates）用于使用模板批量创建签署流程。当前可批量发起合同（签署流程）数量为1-20个。 如若在模板中配置了动态表格, 上传的附件必须为A4大小 合同发起人必须在电子签已经进行实名。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：CreateFlowsByTemplates。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
FlowInfos.N是Array of FlowInfo要创建的合同信息列表，最多支持一次创建20个合同
NeedPreview否Boolean是否为预览模式；默认为false，即非预览模式，此时发起合同并返回FlowIds；若为预览模式，不会发起合同，会返回PreviewUrls；
预览链接有效期300秒；
同时，如果预览的文件中指定了动态表格控件，需要进行异步合成；此时此接口返回的是合成前的文档预览链接，而合成完成后的文档预览链接会通过：回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询；
示例值：false
PreviewType否Integer预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
示例值：0

3. 输出参数​

参数名称类型描述
FlowIdsArray of String多个合同ID
示例值：["xx","yy"]
CustomerDataArray of String第三方应用平台的业务信息, 与创建合同的FlowInfos数组中的CustomerData一一对应
示例值：["",""]
ErrorMessagesArray of String创建消息，对应多个合同ID，
成功为“”,创建失败则对应失败消息
示例值：["",""]
PreviewUrlsArray of String预览模式下返回的预览文件url数组
示例值：["xx","yy"]
TaskInfosArray of TaskInfo复杂文档合成任务（如，包含动态表格的预览任务）的任务信息数组；
如果文档需要异步合成，此字段会返回该异步任务的任务信息，后续可以通过ChannelGetTaskResultApi接口查询任务详情；
FlowApproversArray of FlowApproverItem签署方信息，如角色ID、角色名称等
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 B2B 模板发起示例​

双方企业均已认证 发起示例

输入示例​

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

{
    "Agent": {
        "ProxyOrganizationOpenId": "d7c13a8b***********68c0ee248f04",
        "ProxyOperator": {
            "OpenId": "00498cc***********3aff766cac"
        },
        "AppId": "65fb0c59***********a382cc5ed0e"
    },
    "FlowInfos": [
        {
            "FlowName": "测试流程一",
            "TemplateId": "005c***********4f7f64e8c",
            "FlowDescription": "测试流程一的描述信息",
            "FlowType": "合同",
            "Deadline": 1604910797,
            "CallbackUrl": "",
            "FormFields": [
                {
                    "ComponentName": "姓名",
                    "ComponentValue": "李四"
                }
            ],
            "FlowApprovers": [
                {
                    "ApproverType": "ORGANIZATION",
                    "OpenId": "00498cc8***********aff766cac",
                    "RecipientId": "yDxjbUU***********zjEuCkSaxt8n"
                },
                {
                    "ApproverType": "ORGANIZATION",
                    "OpenId": "eezi_openid",
                    "OrganizationOpenId": "organization1_open_id",
                    "OrganizationName": "鹅鹅子的企业",
                    "RecipientId": "yDxjbUU***********ChJBkK7qS"
                }
            ]
        }
    ]
}

输出示例​

{
    "Response": {
        "CustomerData": [
            ""
        ],
        "FlowIds": [
            "yDxMqU***********vaigGvi"
        ],
        "PreviewUrls": [
            ""
        ],
        "ErrorMessages": [
            ""
        ],
        "TaskInfos": [
            {
                "TaskId": "taskid",
                "TaskStatus": "status"
            }
        ],
        "RequestId": "s16294xxxxx0001803"
    }
}

示例2 使用模板批量创建签署流程​

使用模板批量创建签署流程

输入示例​

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

{
    "Agent": {
        "ProxyOrganizationOpenId": "d7c13a8***********0ee248f04",
        "ProxyOperator": {
            "OpenId": "00498cc***********3aff766cac"
        },
        "AppId": "65f***********aa382cc5ed0e"
    },
    "FlowInfos": [
        {
            "FlowName": "测试签署流程一",
            "TemplateId": "005c7f***********4f7f64e8c",
            "FlowDescription": "测试签署流程一的描述信息",
            "FlowType": "合同",
            "Deadline": 1604910797,
            "CallbackUrl": "",
            "FormFields": [
                {
                    "ComponentName": "姓名",
                    "ComponentValue": "李四"
                }
            ],
            "FlowApprovers": [
                {
                    "Name": "李四",
                    "Mobile": "13888888888",
                    "Deadline": 1604910798
                }
            ]
        },
        {
            "FlowName": "测试签署流程二",
            "TemplateId": "005c7***********oqwnrf4e8c",
            "FlowDescription": "测试签署流程二的描述信息",
            "FlowType": "合同",
            "Deadline": 1604910797,
            "CallbackUrl": "",
            "FormFields": [
                {
                    "ComponentName": "姓名",
                    "ComponentValue": "张三"
                }
            ],
            "FlowApprovers": [
                {
                    "Name": "鹅鹅子",
                    "ApproverType": "PERSON",
                    "Mobile": "13200000000",
                    "Deadline": 1663336465
                },
                {
                    "Name": "发起方",
                    "ApproverType": "ORGANIZATION",
                    "Mobile": "13700000000",
                    "OpenId": "12345678",
                    "Deadline": 1663336465
                }
            ]
        }
    ]
}

输出示例​

{
    "Response": {
        "CustomerData": [
            "",
            ""
        ],
        "FlowIds": [
            "yDxM***********trvvaigGvi",
            "yDxMq***********1trvvaigGv2"
        ],
        "PreviewUrls": [
            "",
            ""
        ],
        "ErrorMessages": [
            "",
            ""
        ],
        "TaskInfos": [
            {
                "TaskId": "taskid",
                "TaskStatus": "status"
            }
        ],
        "RequestId": "s162944xxxxx3"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InternalError.System系统错误。
InvalidParameter参数错误。
InvalidParameter.Application应用号不存在。
InvalidParameter.ApproverVerifyTypeApproverVerifyType参数值非法
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请升级到对应版本后即可使用该接口。