Pusat pembangun

Muat turun fail

GET /esignglobal/v1/envelope/files/download

Deskripsi Antara Muka

Hanya apabila sampul surat telah selesai, muat turun fail dalam sampul surat yang dibungkus disokong.

Parameter Permintaan

Nama Parameter

Jenis

Diperlukan

Keterangan

envelopeId

string

true

ID Sampul Surat

downloadType

stringfalse

Jenis format muat turun fail: 

  • zip (lalai): Mengembalikan pautan muat turun pakej termampat
  • list: 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 Sampul Surat

envelopeStatus

int

Status Sampul Surat

0-Dicipta (Draf)

1-Sedang Ditandatangani

2-Selesai

3-Telah Tamat Tempoh

4-Ditolak

5-Dibatalkan

downloadUrl

string

Alamat Muat Turun Fail

【注意】Sah dalam masa 30 minit, sila minta semula antara muka untuk mendapatkan alamat muat turun selepas tamat tempoh

Dikembalikan apabila downloadType=zip

envelopeFiles

array

Koleksi Fail Sampul Surat

Koleksi Fail Sampul Surat

【注意】Dikembalikan apabila downloadType=list

 

fileType

string

Jenis Fail

CONTRACT-Dokumen yang ditandatangani

ATTACHMENT-Lampiran

CERTIFICATE-Sijil

 

fileName

string

Nama Fail

 

downloadUrl

string

Pautan Muat Turun Fail (Sah dalam 60 minit)

Contoh Respons

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

 

Deskripsi Antara Muka
Parameter Permintaan
Contoh Permintaan
Parameter Respons
Contoh Respons