Скачать файл

GET /esignglobal/v1/envelope/files/download

Описание интерфейса

Поддерживается скачивание файлов из конверта во время процесса подписания или после его завершения. Скачивание во время подписания регулируется настройками загрузки по этапам, правами на загрузку и правилами видимости файлов; если для файла требуется асинхронное создание водяного знака, интерфейс возвращает идентификатор задачи загрузки, и клиент может получить результат файла через интерфейс запроса статуса задачи загрузки или через обратный вызов о завершении задачи загрузки.

Параметры запроса

Имя параметра	Тип	Обязательный	Примечание
envelopeId	string	true	Идентификатор конверта
downloadType	string	false	Тип формата загрузки файла: zip (по умолчанию): возвращает ссылку для загрузки архива list: возвращает список файлов

Пример запроса

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

Параметры ответа

Имя параметра		Тип	Описание
envelopeId		string	Идентификатор конверта
envelopeStatus		int	Статус конверта 0- Создан (черновик) 1-20190528165728 2- Завершён 3- Истёк срок действия 5- Отменён
taskId		string	Идентификатор задачи загрузки. Возвращается только если конверт находится в статусе «Подписывается» и для файлов требуется асинхронная композитная обработка водяных знаков. [Примечание] При возврате taskId поля результатов файлов, такие как downloadUrl и envelopeFiles, не возвращаются.
downloadUrl		string	URL-адрес загрузки файла [Примечание] Действует в течение 30 минут; по истечении срока действия повторно запросите API для получения URL-адреса загрузки Возвращается при downloadType=zip и возможности синхронного возврата результатов файлов; не возвращается при возврате taskId.
envelopeFiles		array	Набор файлов конверта [Примечание] Возвращается при downloadType=list и возможности синхронного возврата результатов файлов; не возвращается при возврате taskId.
	fileType	string	Тип файла CONTRACT- Подписываемый файл ATTACHMENT- Вложение CERTIFICATE- Сертификат COMBINED- PDF-файл, объединяющий «Подписываемый файл» и «Доказательство завершения подписания»; возвращается при включенной опции «Объединенная загрузка файлов конверта»
	fileName	string	Имя файла
	downloadUrl	string	Ссылка для скачивания файла (действительна в течение 60 минут)

Пример ответа

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

Если файл находится в процессе подписания и требуется асинхронное создание водяного знака, пример ответа будет следующим:

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