eSignGlobaleSignGlobal
開発者センター

ファイルをダウンロード

GET /esignglobal/v1/envelope/files/download

API説明

信封が完了している場合のみ、封筒内のファイルをパッケージ化してダウンロードできます。

リクエストパラメータ

パラメータ名

必須

説明

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-期限切れ

5-取消済み

downloadUrl

string

ファイルダウンロードURL

【注意】30分間のみ有効です。期限が切れた場合は、再度APIを呼び出してダウンロードURLを取得してください。

downloadType=zipの場合に返却

envelopeFiles

array

エンベロープファイル一覧

エンベロープファイル一覧

【注意】downloadType=listの場合に返却

 

fileType

string

ファイルタイプ

CONTRACT-署名ファイル

ATTACHMENT-添付ファイル

CERTIFICATE-証明書

COMBINED-「署名ファイル」と「署名完了証明書」をマージしたPDFファイル。「封筒ファイル結合ダウンロード」が有効な場合に返却

 

fileName

string

ファイル名

 

downloadUrl

string

ファイルダウンロードURL(60分間有効)

レスポンス例

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