跳到主要内容

模板发起合同-创建电子文档

1. 接口描述​

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

创建签署流程电子文档 适用场景：见创建签署流程接口。 注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：CreateDocument。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，本接口不需要传递此参数。
Operator是UserInfo调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
FlowId是String签署流程编号,由CreateFlow接口返回
TemplateId是String用户上传的模板ID
FileNames.N否Array of String文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
FormFields.N否Array of FormField内容控件信息数组
NeedPreview否Boolean是否需要生成预览文件 默认不生成；
预览链接有效期300秒；
PreviewType否Integer预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
Agent否Agent代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
ClientToken否String客户端Token，保持接口幂等性,最大长度64个字符

3. 输出参数​

参数名称类型描述
DocumentIdString签署流程电子文档ID
PreviewFileUrlString签署流程文件的预览地址, 5分钟内有效。仅当NeedPreview为true 时返回
注意：此字段可能返回 null，表示取不到有效值。
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 创建电子文档​

创建流程对应的文档

输入示例​

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

{
    "Operator": {
        "UserId": "112345678********45678901"
    },
    "FileNames": [
        "文件名"
    ],
    "FlowId": "c7b5ca37ae*******2b4c6644",
    "TemplateId": "00033ed4d1********a82a9",
    "ClientToken": "c5qwe37ae*******g4qw8v1e",
    "NeedPreview": true,
    "FormFields": [
        {
            "ComponentValue": "控件填充内容",
            "ComponentId": "控件ID"
        }
    ]
}

输出示例​

{
    "Response": {
        "RequestId": "s123456789",
        "DocumentId": "yDxM6**********KAMwutBsRy",
        "PreviewFileUrl": "https://file.ess.tencent.cn/bresource/resource/resource/0/xxxxxxxxx"
    }
}

5. 开发者资源​

腾讯云 API 平台​

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector​

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK​

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具​

6. 错误码​

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

错误码描述
FailedOperation操作失败。
FailedOperation.FlowHasDocument签署流程已有关联文档，请检查参数修改后重试。
FailedOperation.FlowHasNoDocument流程未找到关联的电子文件信息，请检查操作步骤，检查参数，并在修改后重试。
FailedOperation.PreViewUrlFail创建签署流程预览链接失败，请稍后重试。
FailedOperation.TemplateHasNoResource模板无资源信息。
InternalError内部错误。
InternalError.Api第三方接口失败。
InternalError.Db数据库异常。
InternalError.DbConnection数据库连接出错。
InternalError.DbInsert数据库新增记录出错。
InternalError.JsonMarshalJson序列化失败。
InternalError.System系统错误，请稍后重试。
InvalidParameter参数错误。
InvalidParameter.ApproverType不合法的签署人类型，请检查后重试。
InvalidParameter.CardNumber不合法的证件信息，请检查证件号证件类型是否正确。
InvalidParameter.CardType不合法的证件信息，请检查证件号证件类型是否正确。
InvalidParameter.ClientTokenClientToken不合法请检查。
InvalidParameter.ComponentPage不合法的控件页码，请与文件资源检查，并在修改后重试。
InvalidParameter.ComponentTypeNoMatchValue控件的类型与输入值不匹配，请检查参数修改后重试。
InvalidParameter.DataNotFound数据不存在。
InvalidParameter.EmptyParams参数为空，请检查参数修改后重试。
InvalidParameter.InvalidIdid类型参数不合法，请检查后重试。
InvalidParameter.ParamError参数错误。
InvalidParameter.SealId不合法的印章id，请检查印章id是否正确，并在修改后重试。
InvalidParameterValue参数取值错误。
InvalidParameterValue.Mask需要屏蔽的告警。
MissingParameter.ApproverSignComponent缺少签署人签署控件配置，请联系客服了解控件传递规则，并在修改后重试。
MissingParameter.FileNames文件名为空，请检查参数修改后重试。
MissingParameter.Recipient缺少模板签署人信息，请检查后重试。
MissingParameter.ServerSignSealId缺少静默签印章id，请检查修改后重试。
MissingParameter.SignComponents缺少签署控件参数。
OperationDenied操作被拒绝。
OperationDenied.ApproverNoMatchTemplate签署人设置与模板中签署人配置信息不一致，请检查模板修改参数后重试。
OperationDenied.FileNoMatchResource文件与资源不匹配，请检查文件名与资源id数量以及对应关系，并在修改后重试。
OperationDenied.Forbid禁止此项操作。
OperationDenied.NoIdentityVerify未通过个人实名认证。
OperationDenied.NoLogin用户未登录,请先登录后再操作。
OperationDenied.ServerSignNoAllowComponent静默签署方不允许有填写控件，请修改模板，修改参数后重试。
ResourceNotFound资源不存在。
ResourceNotFound.Document未找到电子文档信息，请检查后重试。
ResourceNotFound.Template模板不存在，请检查模板参数，模板配置，并稍后重试。
ResourceNotFound.User用户或者员工信息不存在，请检查参数后重试。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。