eSignGlobaleSignGlobal
Entwicklerzentrum

Datei herunterladen

GET /esignglobal/v1/envelope/files/download

Schnittstellenbeschreibung

Das Herunterladen von Dateien innerhalb eines Umschlags wird nur unterstützt, wenn der Umschlag abgeschlossen ist.

Anfrageparameter

Parametername

Typ

Erforderlich

Beschreibung

envelopeId

string

true

Umschlag-ID

downloadType

stringfalse

Dateidownload-Formattyp: 

  • zip (Standard): Gibt einen Link zum Herunterladen der komprimierten Datei zurück
  • list: Gibt eine Dateiliste zurück 

Beispielanfrage

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

Antwortparameter

Parametername

Typ

Beschreibung

envelopeId

string

Umschlag-ID

envelopeStatus

int

Umschlagstatus

0-Erstellt (Entwurf)

1-In Bearbeitung

2-Abgeschlossen

3-Abgelaufen

5-Widerrufen

downloadUrl

string

Download-Adresse der Datei

【Hinweis】Gültig für 30 Minuten. Bitte fordern Sie nach Ablauf der Gültigkeit die Download-Adresse erneut über die Schnittstelle an.

Wird zurückgegeben, wenn downloadType=zip ist

envelopeFiles

array

Umschlag-Dateisammlung

Umschlag-Dateisammlung

【Hinweis】Wird zurückgegeben, wenn downloadType=list ist

 

fileType

string

Dateityp

CONTRACT-Unterzeichnetes Dokument

ATTACHMENT-Anhang

CERTIFICATE-Zertifikat

COMBINED-Eine PDF-Datei, die „Unterzeichnetes Dokument“ und „Nachweis der abgeschlossenen Unterzeichnung“ zusammenführt. Wird zurückgegeben, wenn „Umschlagdokumente als zusammengeführter Download“ aktiviert ist.

 

fileName

string

Dateiname

 

downloadUrl

string

Datei-Download-Adresse (gültig für 60 Minuten)

Beispielantwort

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