准备待发起文件

1. 接口描述

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

该接口 (PrepareFlows) 用于创建待发起文件 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。 目前该接口只支持B2C， 不建议使用，将会废弃。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：PrepareFlows。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
FlowInfos.N	是	Array of FlowInfo	多个合同（签署流程）信息，最大支持20个签署流程。
JumpUrl	是	String	操作完成后的跳转地址，最大长度200

3. 输出参数

参数名称	类型	描述
ConfirmUrl	String	待发起文件确认页 示例值：https://ess.tencent.com
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建待发起文件

创建待发起文件

输入示例

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

{
    "Agent": {
        "ProxyOrganizationOpenId": "test",
        "ProxyOperator": {
            "OpenId": "test"
        },
        "AppId": "x"
    },
    "JumpUrl": "http://www.test.com",
    "FlowInfos": [
        {
            "FlowName": "测试签署流程一",
            "TemplateId": "test",
            "FlowDescription": "测试签署流程一的描述信息",
            "FlowType": "合同",
            "Deadline": 1604910797,
            "FormFields": [
                {
                    "ComponentName": "姓名",
                    "ComponentValue": "李四"
                }
            ],
            "FlowApprovers": [
                {
                    "Name": "李四",
                    "Mobile": "13888888888",
                    "Deadline": 1604910798
                }
            ]
        },
        {
            "FlowName": "测试签署流程二",
            "TemplateId": "test",
            "FlowDescription": "测试签署流程二的描述信息",
            "FlowType": "合同",
            "Deadline": 1604910797,
            "FormFields": [
                {
                    "ComponentName": "姓名",
                    "ComponentValue": "张三"
                }
            ],
            "FlowApprovers": [
                {
                    "Name": "鹅鹅子",
                    "ApproverType": "PERSON",
                    "Mobile": "13200000000",
                    "Deadline": 1663336465
                },
                {
                    "Name": "发起方",
                    "ApproverType": "ORGANIZATION",
                    "Mobile": "13700000000",
                    "OpenId": "12345678",
                    "Deadline": 1663336465
                }
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "ConfirmUrl": "https://www.xx.com",
        "RequestId": "id"
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.Api	其他API错误。
InternalError.Db	数据库错误。
InternalError.System	系统错误。
InvalidParameter	参数错误。
InvalidParameter.DataNotFound	数据不存在。
InvalidParameter.FlowDeadLine	参数错误，不合法的签署流程截止日期，请修改后重试。
InvalidParameter.FlowName	参数错误，不合法的签署流程名称，请修改后重试。
InvalidParameter.Name	姓名不符合要求。
InvalidParameter.ParamError	参数错误。
LimitExceeded.FlowInfos	超出流程数量限制。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
ResourceNotFound.Application	应用号不存在。
ResourceNotFound.Organization	机构不存在。
ResourceNotFound.Template	模板不存在。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。