跳到主要内容

根据签署流程信息批量获取资源下载链接

1. 接口描述​

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

根据签署流程信息批量获取资源下载链接，可以下载签署中、签署完的合同，需合作企业先进行授权。 此接口直接返回下载的资源的url，与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：DescribeResourceUrlsByFlows。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent应用相关信息。
此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
FlowIds.N否Array of String查询资源所对应的签署流程Id，最多支持50个
示例值："xxx"

3. 输出参数​

参数名称类型描述
FlowResourceUrlInfosArray of FlowResourceUrlInfo签署流程资源对应链接信息
ErrorMessagesArray of String创建消息，对应多个合同ID，
成功为“”,创建失败则对应失败消息
示例值：["",""]
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 根据签署流程信息批量获取资源下载链接​

根据签署流程信息批量获取资源下载链接

输入示例​

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test"
        },
        "ProxyOrganizationOpenId": "test",
        "AppId": "test"
    },
    "FlowIds": [
        "test"
    ]
}

输出示例​

{
    "Response": {
        "FlowResourceUrlInfos": [
            {
                "FlowId": "123",
                "ResourceUrlInfos": [
                    {
                        "Url": "https://",
                        "Type": "test",
                        "Name": "test"
                    }
                ]
            }
        ],
        "ErrorMessages": [
            ""
        ],
        "RequestId": "12345"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InternalError.Api其他API错误。
InternalError.Db数据库错误。
InternalError.System系统错误。
InvalidParameter参数错误。
InvalidParameter.Application应用号不存在。
InvalidParameter.ParamError参数错误。
InvalidParameterValue参数取值错误。
MissingParameter缺少参数错误。
MissingParameter.FlowId缺少流程id，请检查后重试。
MissingParameter.UserOpenIdOpenId不存在。
OperationDenied操作被拒绝。
OperationDenied.OutQueryLimit超出查询上限。
OperationDenied.UserNotInOrganization用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
ResourceNotFound.Organization机构不存在。
ResourceNotFound.Template模板不存在。
ResourceUnavailable资源不可用。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
UnauthorizedOperation.UnauthorizedOperationDownload未授权下载权限。
UnauthorizedOperation.UnauthorizedOperationOrganization企业没有被授权。