获取合同（流程）批量下载链接

1. 接口描述

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

此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式分类下载。当前接口限制最多合同（流程）50个.

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetDownloadFlowUrl。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，本接口不需要传递此参数。
Agent	是	Agent	应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
DownLoadFlows.N	否	Array of DownloadFlowInfo	文件夹数组，签署流程总数不能超过50个，一个文件夹下，不能超过20个签署流程
Operator	否	UserInfo	操作者的信息，不用传

3. 输出参数

参数名称	类型	描述
DownLoadUrl	String	合同（流程）下载地址
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

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

输入示例

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

{
    "Agent": {
        "ProxyAppId": "c17bdf9c2xxxxx1f4d0200fef3d",
        "ProxyOrganizationOpenId": "d7c13a8xxxxe9e3968c0ee248f04",
        "ProxyOperator": {
            "OpenId": "00498cc8500be9cxxxxxxx3aff766cac"
        },
        "AppId": "65fb0c5910xxxxaa382cc5ed0e"
    },
    "DownLoadFlows": [
        {
            "FlowIdList": [
                "test-flow-id1",
                "test-flow-id2"
            ],
            "FileName": "文件夹1"
        },
        {
            "FlowIdList": [
                "test-flow-id3",
                "test-flow-id4"
            ],
            "FileName": "文件夹2"
        }
    ]
}

输出示例

{
    "Response": {
        "DownLoadUrl": "https://xxx.xxxx.tencent.com/template-preview?channel=PROXYCHANNEL&expiredTime=1639587153&code=yDxjKUUgydjf9pxxxx4adWk38k&token=yDxjKxxxpruUuO4zjES4adWk38k&operate=downloadFlow",
        "RequestId": "s16221xxx14775648"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
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.ApplicationId	ApplicationId不存在。
ResourceNotFound.File	文件不存在。
ResourceNotFound.Flow	未找到对应流程。
ResourceNotFound.TeamWorkOrganization	合作企业不存在。
ResourceNotFound.User	用户信息不存在。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。
UnauthorizedOperation.UnauthorizedOperationDownload	未授权下载权限。
UnauthorizedOperation.UnauthorizedOperationOrganization	企业没有被授权。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

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

输入示例​

输出示例​

5. 开发者资源​

腾讯云 API 平台​

API Inspector​

SDK​

命令行工具​

6. 错误码​