跳到主要内容

获取合同PDF下载链接

1. 接口描述​

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

获取合同流程PDF的下载链接，可以下载签署中、签署完的此子企业创建的合同。

2. 确保合同的PDF已经合成后，再调用本接口。​

用户创建合同或者提交签署动作后，后台需要1~3秒的时间就进行合同PDF合成或者签名，为了确保您下载的是签署完成的完整合同文件，我们建议采取下面两种方式的一种来确保PDF已经合成完成，然后在调用本接口。

第一种：请确保您的系统配置了接收合同完成通知的回调功能。一旦所有参与方签署完毕，我们的系统将自动向您提供的回调地址发送完成通知。

第二种：通过调用我们的获取合同信息接口来主动检查合同的签署状态。请仅在确认合同状态为“全部签署完成”后，进行文件的下载操作。

3. 链接具有有效期限​

生成的链接是有时间限制的，过期后将无法访问。您可以在接口返回的信息中查看具体的过期时间。为避免错误，请确保在链接过期之前进行下载操作。

4. 有两种开通下载权限的途径。​

第一种: 需第三方应用的子企业登录控制台进行授权, 授权在企业中心的授权管理区域, 界面如下图。 授权过程需要子企业超管扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>

image

第二种: 渠道方企业在企业应用管理的配置界面打开需要配置的应用，点击应用扩展服务开通此功能，需要渠道方企业的超管扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>> 注:

  1. 请注意如果第三方应用的子客主动关闭了渠道端下载渠道子客合同功能开关，那么渠道方开通了此功能也无法下载子客的合同文件

image

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

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

2. 输入参数​

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

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

此接口下面信息必填。

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


第三方平台子客企业和员工必须已经经过实名认证
FlowIds.N否Array of String需要下载的合同流程的ID, 至少需要1个, 做多50个
示例值：["yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh"]

3. 输出参数​

参数名称类型描述
FlowResourceUrlInfosArray of FlowResourceUrlInfo合同流程PDF下载链接
ErrorMessagesArray of String如果某个序号的合同流程生成PDF下载链接成功, 对应序号的值为空
如果某个序号的合同流程生成PDF下载链接失败, 对应序号的值为错误的原因
示例值：["合同没有权限","合同不存在"]
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 批量获取下载链接全成功​

批量获取2个合同流程全部成功

输入示例​

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "FlowIds": [
        "yDwivUUckpor6wtoUuogwQHCAB0ES0pQ",
        "yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh"
    ]
}

输出示例​

{
    "Response": {
        "FlowResourceUrlInfos": [
            {
                "FlowId": "yDwivUUckpor6wtoUuogwQHCAB0ES0pQ",
                "ResourceUrlInfos": [
                    {
                        "Url": "https://file.test.ess.tencent.cn/file/FLOW/yDwivUUckpor6wtoUuogwQHCAB0ES0pQ/0/0.PDF?hkey=70b1**9c63e",
                        "Name": "合同,270481027143248.pdf",
                        "Type": "PDF"
                    }
                ]
            },
            {
                "FlowId": "yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh",
                "ResourceUrlInfos": [
                    {
                        "Url": "https://file.test.ess.tencent.cn/file/FLOW/yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh/0/0.PDF?hkey=70b1**c63",
                        "Name": "合同,250151025185515.pdf",
                        "Type": "PDF"
                    }
                ]
            }
        ],
        "ErrorMessages": [
            "",
            ""
        ],
        "RequestId": "d49c0838-94b6-45f8-995e-42f61dfa0c05"
    }
}

示例2 批量获取下载链接一个成功一个失败​

批量获取2个合同流程的下载链接, 因第一个合同yDwivUUckpor6wtoUuogwQHCAB0ES0p1不存在, 第二个合同获取成功

输入示例​

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "FlowIds": [
        "yDwivUUckpor6wtoUuogwQHCAB0ES0p1",
        "yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh"
    ]
}

输出示例​

{
    "Response": {
        "FlowResourceUrlInfos": [
            {
                "FlowId": "yDwivUUckpor6wtoUuogwQHCAB0ES0p1",
                "ResourceUrlInfos": []
            },
            {
                "FlowId": "yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh",
                "ResourceUrlInfos": [
                    {
                        "Url": "https://file.test.ess.tencent.cn/file/FLOW/yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh/0/0.PDF?hkey=70b1***9c63",
                        "Name": "合同,250151025185515.pdf",
                        "Type": "PDF"
                    }
                ]
            }
        ],
        "ErrorMessages": [
            "查询流程不存在",
            ""
        ],
        "RequestId": "2e9fc432-53b4-4286-b706-7a5de509310b"
    }
}

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企业没有被授权。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062