파일 다운로드

GET /esignglobal/v1/envelope/files/download

인터페이스 설명

신봉 서명 중 또는 완료 시, 신봉 내 파일 다운로드를 지원합니다. 서명 중 다운로드는 프로세스 다운로드 구성, 다운로드 권한 및 파일 가시성 규칙에 따라 제한됩니다. 서명 중 파일에 워터마크 비동기 합성이 필요한 경우, 인터페이스는 다운로드 작업 ID를 반환하며, 클라이언트는 다운로드 작업 조회 인터페이스 또는 다운로드 작업 완료 콜백을 통해 파일 결과를 얻을 수 있습니다.

요청 매개변수

매개변수 이름	유형	필수 여부	설명
envelopeId	string	true	신봉 ID
downloadType	string	false	파일 다운로드 형식 유형: zip(기본값): 압축 파일 다운로드 링크 반환 list: 파일 목록 반환

요청 예시

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

응답 매개변수

매개변수 이름		유형	설명
envelopeId		string	봉투 ID
envelopeStatus		int	봉투 상태 0- 생성됨(초안) 1- 서명 중 2- 완료됨 3- 만료됨 5- 취소됨
taskId		string	다운로드 작업 ID. 봉투가 서명 중이고 파일에 워터마크 비동기 합성이 필요한 경우에만 반환됩니다. [주의] taskId를 반환할 때 downloadUrl, envelopeFiles 등의 파일 결과 필드는 반환되지 않습니다.
downloadUrl		string	파일 다운로드 주소 [주의] 30분간 유효하며, 만료된 후 다운로드 주소를 다시 얻으려면 인터페이스를 다시 요청하십시오. 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"
}