Télécharger le fichier

GET /esignglobal/v1/envelope/files/download

Description de l'interface

Lorsque le pli est en cours de signature ou a été signé, il est possible de télécharger les fichiers contenus dans le pli. Le téléchargement pendant la phase de signature est soumis aux configurations de téléchargement du processus, aux autorisations de téléchargement et aux règles de visibilité des fichiers ; si un filigrane doit être appliqué de manière asynchrone au fichier pendant la signature, l'interface renvoie un ID de tâche de téléchargement. Le client peut alors récupérer le résultat du fichier via l'interface de consultation des tâches de téléchargement ou par le biais d'une notification de fin de tâche de téléchargement.

Paramètres de requête

Nom du paramètre	Type	Obligatoire	Description
envelopeId	string	true	ID du pli
downloadType	string	false	Format de type de téléchargement de fichier : zip (par défaut) : renvoie un lien de téléchargement pour l'archive compressée list : renvoie une liste de fichiers

Exemple de requête

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

Paramètres de réponse

Nom du paramètre		Type	Description
envelopeId		string	ID du pli
envelopeStatus		int	État du pli 0- Créé (brouillon) 1- En cours de signature 2- Terminé 3- Expiré 5- Révoqué
taskId		string	ID de la tâche de téléchargement. Renvoyé uniquement lorsque le pli est en cours de signature et que les fichiers nécessitent une synthèse asynchrone avec filigrane. [Remarque] Lorsque taskId est renvoyé, les champs de résultat de fichier tels que downloadUrl et envelopeFiles ne sont pas renvoyés.
downloadUrl		string	URL de téléchargement du fichier [Remarque] Valide pendant 30 minutes ; veuillez refaire une demande d'interface pour obtenir l'URL de téléchargement après expiration. Renvoyé lorsque downloadType=zip et que les résultats des fichiers peuvent être renvoyés de manière synchrone ; ce champ n'est pas renvoyé lorsque taskId est présent.
envelopeFiles		array	Ensemble des fichiers du pli [Remarque] Renvoyé lorsque downloadType=list et que les résultats des fichiers peuvent être renvoyés de manière synchrone ; ce champ n'est pas renvoyé lorsque taskId est présent.
	fileType	string	Type de fichier CONTRACT-Fichier à signer ATTACHMENT-Pièce jointe CERTIFICATE-Certificat COMBINED-Fichier PDF combinant le « Fichier à signer » et la « Preuve de signature achevée », renvoyé lorsque l'option « Télécharger les fichiers de l'enveloppe fusionnés » est activée
	fileName	string	Nom du fichier
	downloadUrl	string	URL de téléchargement du fichier (valide pendant 60 minutes)

Exemple de réponse

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

Lorsque le fichier est en cours de signature et nécessite une synthèse asynchrone avec filigrane, l'exemple de réponse est le suivant :

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