開発者センター

ファイルをダウンロード

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

ファイルダウンロードアドレス

【注意】30分以内に有効、期限切れ後は再度インターフェースをリクエストしてダウンロードアドレスを取得してください

downloadType=zipの場合に返されます

envelopeFiles

array

封筒ファイルコレクション

封筒ファイルコレクション

【注意】downloadType=listの場合に返されます

 

fileType

string

ファイルタイプ

CONTRACT-署名ファイル

ATTACHMENT-添付ファイル

CERTIFICATE-証明書

 

fileName

string

ファイル名

 

downloadUrl

string

ファイルダウンロードアドレス(60分以内に有効)

レスポンス例

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

 

インターフェースの説明
リクエストパラメータ
リクエスト例
レスポンスパラメータ
レスポンス例