Unduh File

GET /esignglobal/v1/envelope/files/download

Deskripsi Antarmuka

Saat proses penandatanganan amplop sedang berlangsung atau telah selesai, Anda dapat mengunduh file di dalam amplop. Pengunduhan selama proses penandatanganan tunduk pada konfigurasi pengunduhan alur kerja, hak akses unduh, dan aturan visibilitas file; jika file memerlukan komposisi watermark asinkron saat ditandatangani, antarmuka akan mengembalikan ID tugas unduh, dan klien dapat memperoleh hasil file melalui antarmuka kueri tugas unduh atau callback penyelesaian tugas unduh.

Parameter Permintaan

Nama Parameter	Tipe	Wajib	Keterangan
envelopeId	string	true	ID Amplop
downloadType	string	false	Tipe format pengunduhan file: zip (default): mengembalikan tautan unduh arsip terkompresi list: mengembalikan daftar file

Contoh Permintaan

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

Parameter Respons

Nama Parameter		Tipe	Keterangan
envelopeId		string	ID Amplop
envelopeStatus		int	Status Amplop 0-Dibuat (draf) 1-Sedang ditandatangani 2-Selesai 3-Kedaluwarsa 5-Dibatalkan
taskId		string	ID tugas unduhan. Hanya dikembalikan ketika amplop sedang ditandatangani dan file memerlukan komposisi watermark asinkron. [Catatan] Saat mengembalikan taskId, bidang hasil file seperti downloadUrl dan envelopeFiles tidak akan dikembalikan.
downloadUrl		string	Alamat unduhan file [Catatan] Berlaku selama 30 menit; setelah kedaluwarsa, silakan minta ulang antarmuka untuk mendapatkan alamat unduhan Dikembalikan ketika downloadType=zip dan hasil file dapat dikembalikan secara sinkron; tidak dikembalikan saat mengembalikan taskId.
envelopeFiles		array	Kumpulan file amplop [Catatan] Dikembalikan ketika downloadType=list dan hasil file dapat dikembalikan secara sinkron; tidak dikembalikan saat mengembalikan taskId.
	fileType	string	Jenis file CONTRACT-Dokumen yang ditandatangani ATTACHMENT-Lampiran CERTIFICATE-Sertifikat COMBINED-File PDF yang menggabungkan "Dokumen yang ditandatangani" dan "Bukti Penyelesaian Penandatanganan", dikembalikan ketika "Unduhan Penggabungan File Amplop" diaktifkan
	fileName	string	Nama file
	downloadUrl	string	Alamat unduh file (berlaku selama 60 menit)

Contoh respons

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

Saat penandatanganan sedang berlangsung dan file memerlukan komposisi watermark asinkron, contoh respons adalah sebagai berikut:

{
    "code": "0",
    "data": {
      "envelopeId": "xxxx",
      "envelopeStatus": 1,
      "taskId": "task1234567890"
  },
  "message": "success"
}