Descargar archivo

GET /esignglobal/v1/envelope/files/download

Descripción de la interfaz

Cuando el sobre está en proceso de firma o ya ha sido firmado, se admite la descarga de los archivos contenidos en el sobre. La descarga durante el proceso de firma está sujeta a las configuraciones de descarga del flujo, los permisos de descarga y las reglas de visibilidad de los archivos; si es necesario aplicar una marca de agua asíncrona a los archivos durante la firma, la interfaz devuelve un ID de tarea de descarga, y el cliente puede obtener los resultados de los archivos mediante la interfaz de consulta de tareas de descarga o la devolución de llamada de finalización de tareas de descarga.

Parámetros de solicitud

Nombre del parámetro	Tipo	Obligatorio	Descripción
envelopeId	string	true	ID del sobre
downloadType	string	false	Tipo de formato de descarga de archivos: zip (predeterminado): devuelve un enlace para descargar el archivo comprimido list: devuelve una lista de archivos

Ejemplo de solicitud

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

Parámetros de respuesta

Nombre del parámetro		Tipo	Descripción
envelopeId		string	ID del sobre
envelopeStatus		int	Estado del sobre 0-Creado (borrador) 1-En firma 2-Completado 3-Caducado 5-Revocado
taskId		string	ID de la tarea de descarga. Solo se devuelve cuando el estado del sobre es "en firma" y los archivos requieren composición asíncrona con marca de agua. [Nota] Cuando se devuelve taskId, no se devuelven campos de resultados de archivos como downloadUrl o envelopeFiles.
downloadUrl		string	URL de descarga del archivo [Nota] Válido durante 30 minutos; tras su caducidad, vuelva a solicitar la interfaz para obtener la URL de descarga Se devuelve cuando downloadType=zip y los resultados de los archivos pueden devolverse de forma síncrona; no se devuelve este campo cuando se devuelve taskId.
envelopeFiles		array	Conjunto de archivos del sobre [Nota] Se devuelve cuando downloadType=list y los resultados de los archivos pueden devolverse de forma síncrona; no se devuelve este campo cuando se devuelve taskId.
	fileType	string	Tipo de archivo CONTRACT- Documento firmado ATTACHMENT- Archivo adjunto CERTIFICATE- Certificado COMBINED- Archivo PDF que combina el "Documento firmado" y la "Prueba de finalización de firma", devuelto cuando está activada la opción "Descarga combinada de archivos del sobre"
	fileName	string	Nombre del archivo
	downloadUrl	string	URL de descarga del archivo (válido durante 60 minutos)

Ejemplo de respuesta

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

Cuando el documento está en proceso de firma y requiere composición asíncrona con marca de agua, el ejemplo de respuesta es el siguiente:

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