Muat turun fail

GET /esignglobal/v1/envelope/files/download

Penerangan Antara Muka

Apabila surat perjanjian sedang ditandatangani atau telah selesai, fail di dalam surat perjanjian boleh dimuat turun. Muat turun semasa penandatanganan tertakluk kepada konfigurasi muat turun proses, kebenaran muat turun dan peraturan keterlihatan fail; jika fail memerlukan penyusunan watermark secara asinkron semasa penandatanganan, antara muka akan memulangkan ID tugas muat turun, dan pelanggan boleh mendapatkan hasil fail melalui antara muka pertanyaan tugas muat turun atau panggilan balik penyelesaian tugas muat turun.

Parameter Permintaan

Nama Parameter	Jenis	Wajib	Keterangan
envelopeId	string	true	ID Surat Perjanjian
downloadType	string	false	Jenis format muat turun fail: zip (lalai): memulangkan pautan muat turun arkib zip list: memulangkan senarai fail

Contoh Permintaan

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

Parameter Respons

Nama Parameter		Jenis	Penerangan
envelopeId		string	ID Sampul
envelopeStatus		int	Status Sampul 0-Dicipta (draf) 1-Sedang ditandatangani 2-Selesai 3-Telah luput tarikh 5-Dibatalkan
taskId		string	ID tugas muat turun. Hanya dikembalikan apabila sampul sedang ditandatangani dan fail memerlukan sintesis watermark secara tidak segerak. [Perhatian] Apabila taskId dikembalikan, medan hasil fail seperti downloadUrl dan envelopeFiles tidak akan dikembalikan.
downloadUrl		string	Alamat muat turun fail [Perhatian] Sah selama 30 minit; selepas luput, sila minta semula antara muka untuk mendapatkan alamat muat turun Dikembalikan apabila downloadType=zip dan hasil fail boleh dikembalikan secara segerak; tidak dikembalikan apabila taskId dikembalikan.
envelopeFiles		array	Kumpulan fail sampul [Perhatian] Dikembalikan apabila downloadType=list dan hasil fail boleh dikembalikan secara segerak; tidak dikembalikan apabila taskId dikembalikan.
	fileType	string	Jenis fail CONTRACT-Fail tandatangan ATTACHMENT-Lampiran CERTIFICATE-Sijil COMBINED-Fail PDF yang menggabungkan "Fail tandatangan" dan "Bukti Penyelesaian Tandatangan", dikembalikan apabila "Muat turun Fail Gabungan Envelope" diaktifkan
	fileName	string	Nama fail
	downloadUrl	string	Alamat muat turun fail (sah selama 60 minit)

Contoh respons

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

Apabila sedang menandatangani dan fail memerlukan penyusunan air tanda air secara asinkron, contoh respons adalah seperti berikut:

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