合同管理-获取合同与附属文件下载链接

请求参数

Query 参数

contractId

string

可选

合同ID，合同ID与业务ID二选一，不能同时为空

bizId

string

可选

业务ID，合同ID与业务ID二选一，不能同时为空

tenantName

string

可选

子公司名称，若使用业务ID下载合同，且合同是以子公司身份创建的，则需要传递该值，用于确定合同主体

downloadItems

string

可选

下载子项目，子项目可选项：CONTRACT（"合同原文"）、SIGNLOG（"签署日志"）、ATTACHMENT（"附件"）、NOTARY（"存证报告"）、ENDSIGN_ATTACHMENT（“强制结束附件”），各子项以逗号（","）相隔，如CONTRACT,SIGNLOG，默认为合同文件与签署日志

compress

string

可选

是否压缩成zip格式返回单个链接。默认不压缩，每个文件返回单独的下载链接 >如果compress=false，当下载类型为合同原文，返回值中仅返回文档id，不返回合同id，其余下载类型仅返回合同id，不返回文档id；文件名称是单个文件对应的名称、下载链接是单个文档的下载链接； >如果compress=true，返回值中仅返回合同id，不返回文档id；文件名称是合同标题、下载链接是整个合同压缩包的下载链接

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://openapi.qiyuesuo.com/v2/contract/downloadurl' \
--header 'x-qys-open-accesstoken: {{x-qys-open-accesstoken}}' \
--header 'x-qys-open-timestamp: {{x-qys-open-timestamp}}' \
--header 'x-qys-open-nonce: {{x-qys-open-nonce}}' \
--header 'x-qys-open-signature: {{x-qys-open-signature}}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

result

object

必需

downloadUrls

array[object (DocumentUrlResponse) {5}]

下载链接

必需

示例

{
    "result": {
        "downloadUrls": [
            {
                "documentId": "3053227770336247942",
                "title": "ces",
                "downloadItems": "CONTRACT",
                "downloadUrl": "https://m.qiyuesuo.me/stateless/download?key=ac24ed09-6dff-443a-8647-29cf05b5182b"
            },
            {
                "documentId": "3053227772693446794",
                "title": "V2添加模板文档",
                "downloadItems": "CONTRACT",
                "downloadUrl": "https://m.qiyuesuo.me/stateless/download?key=33bccf48-9b2d-4e55-aa4c-34fbfa6cbf6b"
            },
            {
                "contractId": "3053227767890968697",
                "title": "接口发起-签署日志",
                "downloadItems": "SIGNLOG",
                "downloadUrl": "https://m.qiyuesuo.me/stateless/download?key=a2481ab8-6743-40d5-a6b2-5726daa81927"
            }
        ]
    },
    "code": 0,
    "message": "SUCCESS"
}