Центр разработчиков

Скачать файл

GET /esignglobal/v1/envelope/files/download

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

Поддерживается загрузка файлов внутри конверта только после завершения конверта.

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

Название параметра

Тип

Обязательно

Описание

envelopeId

string

true

ID конверта

downloadType

stringfalse

Тип формата загрузки файла: 

  • zip (по умолчанию): возвращает ссылку для скачивания архива
  • list: возвращает список файлов 

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

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

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

Название параметра

Тип

Описание

envelopeId

string

ID конверта

envelopeStatus

int

Статус конверта

0-Создан (черновик)

1-В процессе подписания

2-Завершено

3-Срок действия истек

4-Отклонено

5-Отозвано

downloadUrl

string

URL-адрес для скачивания файла

【注意】Действителен в течение 30 минут, по истечении срока действия повторно запросите интерфейс для получения URL-адреса для скачивания

Возвращается, когда downloadType=zip

envelopeFiles

array

Коллекция файлов конверта

Коллекция файлов конверта

【注意】Возвращается, когда downloadType=list

 

fileType

string

Тип файла

CONTRACT-Подписанный документ

ATTACHMENT-Вложение

CERTIFICATE-Сертификат

 

fileName

string

Имя файла

 

downloadUrl

string

URL-адрес для скачивания файла (действителен в течение 60 минут)

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

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

 

Описание интерфейса
Параметры запроса
Пример запроса
Параметры ответа
Пример ответа