1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
创建合同归档任务
合同归档接口用于将外部系统生成的合同、线下签署完成的合同或历史存量合同归档至腾讯电子签系统,实现合同统一管理。
调用方提交合同文件资源、合同基础信息、签署方信息等数据后,系统将异步创建归档任务进行处理。归档成功后,系统会生成唯一的归档合同 ID(ArchivedFlowId),用于后续合同查询和管理。
合同归档流程:

- 使用UploadFiles 上传文件返回resourceId
- 根据resourceId调用CreateArchiveFlowTask创建合同归档任务返回任务id
- 通过任务ID查询合同归档任务状态
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateArchiveFlowTask。 |
| Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Operator | 是 | UserInfo | 执行本接口操作的员工信息。注: |
| ArchiveFlows.N | 是 | Array of CreateArchiveFlow | 归档合同列表,一次最多支持50个合同 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 归档任务ID,后续使用 查询归档任务状态接口获取归档任务执行结果 示例值:yD3h6UUckpzjnz27UkwEdGoGm3LFAtgX |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建合同归档任务
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateArchiveFlowTask
<公共请求参数>
{
"Operator": {
"UserId": "yDtT9UUckp*****************Q0bO6"
},
"ArchiveFlows": [
{
"ResourceIds": [
"yD3hnUUck***************vmOnrcHE"
],
"FlowName": "测试3-flow_name",
"FlowType": "租房合同",
"BusinessId": "测试3-business_id",
"CreatorName": "发起方",
"ApproverInfo": [
{
"ApproverName": "李白",
"ApproverType": 1,
"ApproverMobile": "1763******1",
"ApproverEmail": "175******1@qq.com",
"ApproverIdCardType": "ID_CARD",
"ApproverIdCardNumber": "4115************12",
"ApproveTime": 1779157787
}
],
"CcInfo": [
{
"ApproverName": "张三"
}
],
"UserData": "用户的自定义数据",
"FlowDescription": "这是合同描述",
"ApproveTime": 1779157787,
"CustomCreatedOn": 1779147787
}
]
}
输出示例
{
"Response": {
"TaskId": "yD3h6UUckpzjnz27UkwEdGoGm3LFAtgX",
"RequestId": "1b9bbc05-1ed1-4c9d-914b-44e327d79e51"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.Db | 数据库异常。 |
| InternalError.Mq | 消息队列失败 |
| InternalError.Serialize | 序列化错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ParamError | 参数错误。 |
| InvalidParameter.Sensitive | 参数包含有敏感词 |
| MissingParameter | 缺少参数错误。 |