eSignGlobaleSignGlobal
Pusat pembangun

Muat turun fail

GET /esignglobal/v1/envelope/files/download

Penerangan Antara Muka

Muat turun fail yang dikumpulkan dalam sampul hanya disokong apabila sampul telah diselesaikan.

Parameter Permintaan

Nama Parameter

Jenis

Diperlukan

Keterangan

envelopeId

string

true

ID Sampul

downloadType

stringfalse

Jenis format muat turun fail:  

  • zip (lalai): mengembalikan pautan muat turun arkib mampat
  • senarai: mengembalikan senarai fail 

Contoh Permintaan

GET https://……/esignglobal/v1/envelope/files/download?envelopeId=flow1234567890&downloadType=list

Parameter Respons

Nama Parameter

Jenis

Keterangan

envelopeId

string

ID Envelope

envelopeStatus

int

Status Envelope

0-Dicipta (draf)

1-Sedang ditandatangani

2-Selesai

3-Tamat tempoh

5-Dibatalkan

downloadUrl

string

Alamat muat turun fail

【Perhatian】Sah selama 30 minit. Sila minta semula antara muka untuk mendapatkan alamat muat turun selepas tamat tempoh.

Dipulangkan apabila downloadType=zip

envelopeFiles

array

Koleksi fail envelope

Koleksi fail envelope

【Perhatian】Dipulangkan apabila downloadType=list

 

fileType

string

Jenis fail

CONTRACT-Fail Ditandatangani

ATTACHMENT-Lampiran

CERTIFICATE-Sijil

COMBINED-Fail PDF yang menggabungkan “Fail Ditandatangani” dan “Sijil Penandatanganan Selesai”, dipulangkan apabila “Muat Turun Fail Gabungan Sampul” diaktifkan

 

fileName

string

Nama Fail

 

downloadUrl

string

Pautan Muat Turun Fail (sah selama 60 minit)

Contoh Respons

{
    "code": "0",
    "data": {
    "envelopeId": "xxxx",
      "downloadUrl": "下载地址",
      "envelopeStatus": 2
  },
  "message": "success"
}