開発者

GET/v3/fax_download?job_id={job_id}

送信ファクスの文書をダウンロードする

ご自身の送信ファクスジョブのうち、取得可能な文書を取得します。

このページの内容
  1. 文書をリクエストする
  2. ファイルまたは JSON エラーを処理する
  3. 取得可能期間とプライバシー

文書をリクエストする

有効な MultiTEL API アカウントを使用してください。パスワード方式のアカウントでは HTTP Basic 認証情報を、トークン方式のアカウントでは Bearer トークンを送信してください。アカウントの権限と IP 制限は引き続き適用されます。内部ワーカーの認証情報は使用しないでください。

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode job_id=0123456789abcdef0123456789abcdef \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_download

必須の job_id には、fax_status と同じ32文字の十六進数を使用してください。顧客からのリクエストは、認証済みの所有者に限られます。この例では、API エラーを PDF と誤認しないよう、レスポンスヘッダーとバイトデータを別々に保存します。

ファイルまたは JSON エラーを処理する

成功時には、Content-Type ヘッダーと添付ファイルを示す Content-Disposition ヘッダーとともに、文書のバイトデータがそのまま返されます。JSON エンベロープではありません。保存したファイルに名前を付けたり、開いたり、処理したりする前に、これらのヘッダーを確認してください。取得可能な文書によって、レスポンスの形式は PDF、TIFF、またはアップロード時の元の形式になります。キューで待機中のジョブでは、変換前の元の文書が返される場合があります。

失敗時には、通常の JSON status/response エンベロープが返されます。API コード 400 は job_id が指定されていないか形式が不正であること、401 は認証がないこと、404 はこのアカウントではジョブまたはそのファイルを取得できないことを意味します。Content-Type と status.code を確認してください。HTTP ステータスが 200 の場合も、この確認が必要です。

取得可能期間とプライバシー

ジョブの記録があっても、ファイルをいつまでもダウンロードできるとは限りません。保存期間は確認されていません。必要に応じて、アクセス権限のある文書をご自身で管理するストレージに保存してください。返されるファイルには、受信者の個人情報が含まれる場合があります。ダウンロードによって新たなファクスが送信されることはありません。