ファイルをダウンロード

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	ファイルのダウンロード先URL 【注意】30分間有効です。期限が切れた場合は、再度APIを呼び出してダウンロード先URLを取得してください。 downloadType=zipで、ファイル結果を同期的に返せる場合に返されます。taskIdを返す場合はこのフィールドは返されません。
envelopeFiles		array	エンベロープファイルのコレクション【注意】downloadType=listで、ファイル結果を同期的に返せる場合に返されます。taskIdを返す場合はこのフィールドは返されません。
	fileType	string	ファイルタイプ CONTRACT-署名ファイル ATTACHMENT-添付ファイル CERTIFICATE-証明書 COMBINED-「署名ファイル」と「署名完了証明」を結合したPDFファイル。「信封ファイルの結合ダウンロード」が有効な場合に返却されます
	fileName	string	ファイル名
	downloadUrl	string	ファイルのダウンロードURL（60分間有効）

レスポンス例

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

署名中で、ファイルに透かしを非同期で合成する必要がある場合のレスポンス例は以下の通りです：

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