跳到主要内容

模板发起合同-发起签署流程

1. 接口描述​

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

此接口用于发起流程 适用场景：见创建签署流程接口。 注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：StartFlow。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，本接口不需要传递此参数。
Operator是UserInfo调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
FlowId是String签署流程编号，由CreateFlow接口返回
ClientToken否String客户端Token，保持接口幂等性,最大长度64个字符
Agent否Agent代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
CcNotifyType否Integer给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知

3. 输出参数​

参数名称类型描述
StatusString返回描述，START-发起成功， REVIEW-提交审核成功，EXECUTING-已提交发起任务
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 发起流程​

发起一份流程

输入示例​

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

{
    "Operator": {
        "UserId": "yDxM6UyK********QDV8dJUuO4zjEu"
    },
    "FlowId": "c7b5ca37ae*******2b4c6644"
}

输出示例​

{
    "Response": {
        "Status": "START",
        "RequestId": "s123456789"
    }
}

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.FlowHasNoDocument流程未找到关联的电子文件信息，请检查操作步骤，检查参数，并在修改后重试。
FailedOperation.NoSignReviewPass签署审核未通过，请先完成审核。
FailedOperation.NotFoundShadowUser未找到集团子企业相关用户信息，请检查用户相关参数
InternalError内部错误。
InternalError.Db数据库异常。
InternalError.DbConnection数据库连接出错。
InternalError.DbRead内部错误,数据库查询失败,请稍后重试。
InternalError.System系统错误，请稍后重试。
InvalidParameter参数错误。
InvalidParameter.ClientTokenClientToken不合法请检查。
InvalidParameter.InvalidIdid类型参数不合法，请检查后重试。
InvalidParameter.ParamError参数错误。
InvalidParameterValue.Mask需要屏蔽的告警。
MissingParameter缺少参数错误。
MissingParameter.ApproverSignComponent缺少签署人签署控件配置，请联系客服了解控件传递规则，并在修改后重试。
OperationDenied操作被拒绝。
OperationDenied.DocumentNoAvailable电子文档不可用，请稍后重试。
OperationDenied.FlowCancelForbid签署流程无法撤销，请检查签署流程状态，检查签署流程归属企业，检查当前操作人是否有权限，并在修改后重试。
OperationDenied.FlowHasStarted签署流程已经被发起，请检查。
OperationDenied.FlowHasTerminated签署流程已经被终止，请检查。
OperationDenied.FlowNoNeedReview签署流程不需要进行审核,请修改后重试。
OperationDenied.FlowStatusForbid签署流程状态不正确，请检查后重试。
OperationDenied.Forbid禁止此项操作。
OperationDenied.NoFlowPermission无权限操作签署流程，请联系客服了解权限，并在修改后重试。
OperationDenied.NoIdentityVerify未通过个人实名认证。
OperationDenied.NoLogin用户未登录,请先登录后再操作。
OperationDenied.NoOpenServerSign未开通静默签功能，请联系签署方企业开通后重试。
OperationDenied.NoQuota企业额度不足，请检查企业额度后处理。
OperationDenied.WhiteListForbid未开通功能白名单，请联系客服处理。
ResourceInUse资源被占用。
ResourceNotFound资源不存在。
ResourceNotFound.Flow签署流程未找到，请检查参数。
ResourceNotFound.FlowApprover签署流程的签署人不存在，请检查后重试。
ResourceNotFound.NotExistDocument电子文档不存在。
ResourceNotFound.NotExistFlow流程不存在。
ResourceNotFound.Organization机构不存在或者未完成认证，请检查机构信息。
ResourceNotFound.Resource未获取到文件资源，请检查资源是否完成上传，是否有效，并在修改后重试。
ResourceUnavailable资源不可用。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
UnknownParameter未知参数错误。
UnsupportedOperation操作不支持。