跳到主要内容

获取控制台下载合同页面跳转链接

1. 接口描述

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

此接口(GetDownloadFlowUrl)用户获取合同控制台下载页面链接, 点击链接后会跳转至本企业合同管理控制台(会筛选出传入的合同列表), 点击下载按钮后就会下载传入的合同列表, 下载页面如下图 image

注:

  • 仅支持下载 本企业 下合同,链接会 登录企业控制台
  • 链接仅可使用一次,不可重复使用

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:GetDownloadFlowUrl。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId


第三方平台子客企业和员工必须已经经过实名认证
DownLoadFlows.NArray of DownloadFlowInfo流程合同ID列表, 可将这些流程ID组织成合同组的形式, 下载时候每个文件夹会是一个zip压缩包, 每个文件夹对多20个合同, 所有文件夹最多50个合同

如下列组织形式, 控制台下载页面点击下载按钮后, 会生成2023采购合同.zip2023入职合同.zip 两个下载任务(注:部分浏览器需要授权或不支持创建多下载任务)

2023采购合同.zip压缩包会有yDwivUUckpor6wtoUuogwQHCAB0ES0pQyDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh两个合同的文件
2023入职合同.zip 压缩包会有yDwivUUckpor6wobUuogwQHvdGfvDi5K的文件

image

3. 输出参数

参数名称类型描述
DownLoadUrlString跳转控制台合同下载页面链接 , 5分钟之内有效,且只能访问一次
RequestIdString唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 生成批量下载控制台连接地址

生成批量下载控制台连接地址

输入示例

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

{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"DownLoadFlows": [
{
"FileName": "2023采购合同",
"FlowIdList": [
"yDwivUUckpor6wtoUuogwQHCAB0ES0pQ",
"yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh"
]
},
{
"FileName": "2023入职合同",
"FlowIdList": [
"yDwivUUckpor6wobUuogwQHvdGfvDi5K",
"yDwFmUUckpst10i3UubBSat8PWOt2iQF",
"yDwFdUUckpswdrniUuzcbXw8N43W6Kcz"
]
}
]
}

输出示例

{
"Response": {
"DownLoadUrl": "https://beta.ess.tencent.cn/contract-mgr?channel=PROXYCHANNEL&expiredTime=1698393037&code=yDwivU**QH1Jir8mgiZ&token=yDwivUUckpo**H1Jir8mgiZ&operate=downloadFlow",
"RequestId": "d6c869b7-6383-4ae5-8c30-6375f392e7c4"
}
}

5. 错误码

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

错误码描述
FailedOperation操作失败。
FailedOperation.FlowNumExceed合同数目超出。
InternalError内部错误。
InternalError.Api其他API错误。
InternalError.System系统错误。
InvalidParameter参数错误。
InvalidParameter.ParamError参数错误。
MissingParameter缺少参数错误。
MissingParameter.FlowInfo未指定流程合同信息。
MissingParameter.OrgOpenId企业OpenId不存在。
OperationDenied操作被拒绝。
OperationDenied.BannedApplication应用号已被禁止。
OperationDenied.DownLoadMoreThanOne只支持下载单个。
OperationDenied.FileDeleted文件已删除。
OperationDenied.UserNotInOrganization用户不归属于当前企业,无法操作,请检查后重试。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
ResourceNotFound.ApplicationIdApplicationId不存在。
ResourceNotFound.File文件不存在。
ResourceNotFound.Flow未找到对应流程。
ResourceNotFound.TeamWorkOrganization合作企业不存在。
ResourceNotFound.User用户信息不存在。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
UnauthorizedOperation.UnauthorizedOperationDownload未授权下载权限。
UnauthorizedOperation.UnauthorizedOperationOrganization企业没有被授权。
UnknownParameter未知参数错误。
UnsupportedOperation操作不支持。
购买咨询
4006-808-062
4006-808-062