GET /esignglobal/v1/envelope/files/download
介面描述
僅在信封已完成時,支援打包信封內的文件下載。
請求參數
參數名稱 | 類型 | 必填 | 說明 |
envelopeId | string | true | 信封 ID |
downloadType | string | false | 文件下載格式類型: zip(預設):返回壓縮包下載連結 list:返回文件列表
|
請求範例
GET https://……/esignglobal/v1/envelope/files/download?envelopeId=flow1234567890&downloadType=list
回應參數
參數名稱 | 類型 | 說明 |
envelopeId | string | 信封 ID |
envelopeStatus | int | 信封狀態 0-已建立(草稿) 1-簽署中 2-已完成 3-已過期 4-已拒簽 5-已撤銷 |
downloadUrl | string | 檔案下載地址 【注意】30分鐘內有效,過期後請重新請求介面獲取下載地址 當downloadType=zip時返回 |
envelopeFiles | array | 信封檔案集合 信封檔案集合 【注意】當downloadType=list時返回 |
| fileType | string | 檔案類型 CONTRACT-簽署文件 ATTACHMENT-附件 CERTIFICATE-證書 COMBINED-合併了“簽署文件”與“簽署完成證明”的PDF檔案,當“信封檔案合併下載”開啟時返回 |
| fileName | string | 檔案名稱 |
| downloadUrl | string | 檔案下載地址(60分鐘內有效) |
回應範例
{
"code": "0",
"data": {
"envelopeId": "xxxx",
"downloadUrl": "下载地址",
"envelopeStatus": 2
},
"message": "success"
}