Dropbox Fax API の設定方法

更新 Oct 17, 2025

In this article

person icon

この記事の情報は、有料の Dropbox Fax プランのお客様向けです。

注：Dropbox Fax のエンドポイントは v1 から v3 に変更されました。v1 エンドポイントは今後メンテナンスされません。 新しい v3 エンドポイントへの移行と開発者にとってのメリットの詳細をご覧ください。

この記事では、v1 エンドポイントを使用して Dropbox Fax API を設定し、動作を確認し、必要に応じて追加の FAX 回線を購入する方法について説明します。

v1 エンドポイントを使用して Dropbox Fax API を設定する方法

v1 エンドポイントの使用を開始するには：

  1. Dropbox Fax アカウントに使用するメールアドレスを記載したメールを support@hellosign.com に送信します。Dropbox Fax API へのアクセスが有効になると、応答が届きます。 Dropbox Fax API の価格についての詳細をご覧ください。
  2. Dropbox Fax アカウントにログインします。 ほとんどの API リクエスト（またはエンドポイント）に必要になるため、アカウント GUID をメモしておいてください。
  3. 最初の API リクエストを行い、アカウントの設定情報を取得します。
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]"
例は次のとおりです： 
curl -u "myemail@hellofax.com:fakepassword" 
        "https://api.hellofax.com/v1/Accounts/15da1c48b10c96a903eb1bac3d592fbed24ebc35"
別の例（URL エンコードすることを忘れないでください）： 
curl "https://myemail%40hellofax.com:fakepassword%40api.hellofax.com/v1/Accounts/15da1c48b10c96a903eb1bac3d592fbed24ebc35"

応答は、アカウント設定の JSON 表記になります。

  1. POST を使用して、受信 FAX と送信 FAX のコールバック URL を再度追加するには：
curl -u"[your username]:[your password]" \
     -d "DefaultInboundFaxCallbackUrl=https://www.example.com/inboundFax" \
     -d "DefaultOutboundFaxCallbackUrl=https://www.example.com/outboundFax" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]"
highlighter icon

注： 受信した FAX は、コールバック URL に POST されるため、個別に取得する必要はありません。

  1. 利用可能な FAX 回線を確認するには：
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/FaxLines"

応答には、プレミアム加入プランに登録する際に選択した FaxLine が含まれます。

  1. FAX 番号を購入するには、GET で利用可能な市外局番を確認する必要があります（すべての市外局番を利用できるわけではありません）。
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/AreaCodes?StateCode=CA"
  1. ステップ 6 で確認した利用可能な市外局番の 1 つから、FAX 番号を購入します。
curl -u "[your username]:[your password]" \
     -d "AreaCode=[area code from step 7]" \ 
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/FaxLines"
  1. FAX を送信するには：
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions?To=[destination phone number]" \ 
     -F "file=@myfile.pdf"

ここから FAX 送信プロセスが開始されます。200 HTTP 応答を受信しても、FAX が送信されるとは限りません。ファイル変換エラーが発生する可能性があります。ただし、FAX のステータス コードが E（エラー）または S（成功）になると、手順 4 で指定したコールバック URL に POST が送信されます。コールバック イベントの詳細をご覧ください。

可能なステータス コードの値：

  • T = 送信中。
  • P = 保留中/変換中。
  • S = 正常に送信済み。
  • E = エラー。変換または完全な送信に失敗しました。
  • H = 保留中。このエラーは、未確認のアカウントがある場合、または月額加入プランを利用していない場合で FAX ページが不足している場合に発生します。

可能なエラー コードの値（ステータス コードが E に設定されている場合のみ参照）：

  • B = ビジー信号を受信。
  • N = 応答なし。
  • A = 未割り当ての番号（通常、接続が切断されていることを意味します）。
  • D = 回線が切断されているか、到達不能。
  • L = この番号は拒否リストに登録されている（米国の番号では発生しないはずです）。
  • U = 原因不明のエラーが発生。これは通常、誰かが電話に応答した際、または FAX 送信中にエラーが発生した際に発生します。

注：

  • FAX を送信し、受信側の FAX 機が加入者識別（CSID）をサポートしている場合、発信者 ID にはプライマリ FAX 番号、または「差出人（From）」パラメータで指定した FAX 番号が表示されます。主な FAX 番号が FAX 自体に表示されます。複数の Dropbox Fax 回線がある場合は、URL に「差出人（From）」パラメータを含めることで、送信する FAX 機として使用する回線を選択できます。
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions?To=[destination phone number]&From=[your fax line phone number]" \
     -F file=@myfile.pdf`

「差出人（From）」の値の形式については、/FaxLines を呼び出して返される「番号（Number）」フィールドを参照してください（上記の手順 5 を参照）。

  • 複数のファイルをアップロードして、1 回の呼び出しで複数の FAX を送信できます。「ファイル（file）」および/または「送信先（To）」パラメータ配列を作成するだけです。
curl -u "[your username]:[your password]" \
     -F file[]="@1.pdf" -F file[]="@2.txt" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions?To=[phone number in all digits]"
curl -X POST https://[your username]:[your password]@api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions -F 'file[0]=@file1.pdf' \
     -F 'file[1]=@file2.pdf' \
     -F 'To[0]=[destination fax number 0]' \
     -F 'To[1]=[destination fax number 1]'
  • 次のパラメーターのうち 1 つ以上を指定することで、Dropbox Fax で生成されたカバー ページを追加できます：CoverPageTo、CoverPageFrom、CoverPageMessage。
  • API によって送信された FAX は、正常に送信されると、サーバーに保存されず、削除されます。したがって、それらを UI で表示することはできません。ただし、コールバックに正常に POST された受信 FAX はサーバーに保存され、「ドキュメント」画面で表示できます。
  • 保留中の FAX は 1 日あたり 200 件までに制限されています。この上限に達すると、429 エラーが発生します。
Error sending fax. Status: 429; Message: Please wait. You already have at least 200 transmissions that are currently pending or transmitting.

FAX ステータスの確認方法

curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions/[Transmission GUID]"
  1. 送信 GUID は、ステップ 8 の API 呼び出しから返される JSON 応答に見ることができます。さらに、送信 GUID を省略すると、すべての送信ステータスを確認できます。
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Your Account GUID]/Transmissions"
これらの結果はページングされます。Page および PageSize URL パラメーターを指定することで、異なるページを取得できます。ページングのしくみについては、FirstPageUri、NextPageUri、PreviousPageUri、LastPageUri 応答要素を参照してください。
highlighter icon

注：

  • API を介して送信された FAX については、確認メールは送信されません。
  • 受信した Fax に対して、通知設定に基づいて通知メールを受信することがあります。

  1. FAX のステータス コードが S または E に設定された場合、発信 FAX コールバック URL がトリガーされたことを確認します。呼び出しの応答で取得するすべてのものを含む「json」というパラメーターを指定した POST を受信する必要があります（手順 1 を参照）。

サーバーまたはネットワークの問題により POST コールバックが正常に行われない場合、Dropbox は次の間隔で再試行します。

  • 15 分
  • 45 分
  • 1 時間 30 分
  • 2 時間 45 分
  • 4 時間
  • 8 時間 15 分
  • 16 時間 30 分

各間隔で、200 応答コードが受信されない場合、Dropbox は POST を複数回試行する場合があります。

  1. 自分の Dropbox Fax 番号に FAX を送信した場合（テストに役立つ）、受信 FAX コールバック URL もトリガーされたことを確認してください。
  2. 購入した FaxLine を一覧表示します。
curl -u "[your username]:[your password]" \
        "https://api.hellofax.com/v1/Accounts/[Account GUID]/FaxLines"
  1. FaxLine を削除するには、その FaxLine の URI に対して DELETE 呼び出しを行います（前の手順の応答で指定されています）。
curl -u "[your username]:[your password]" 
     -X DELETE "https://api.hellofax.com/v1/Accounts/[Account GUID]/FaxLines/2132935579"
操作が成功すると、200 応答が返されます。
highlighter icon

注：コールバック内の JSON に「Transmission」の代わりに「Transaction」が含まれる既知の問題があります。これは、API の次のバージョンで修正されるタイプミスです。

この記事は役立ちましたか？

この記事が役に立たなかった理由をお聞かせください。

ご意見ありがとうございます。

フィードバックありがとうございます。

関連記事

API の使用中にブランディングを追加する方法

Dropbox Sign API でクライアント ID を作成または検索する方法

Dropbox Sign API のエンドユーザー アカウント

Dropbox Sign API の容量制限の使用について

コミュニティの回答

その他のサポート

2 人の人物を描いたアイコン
コミュニティ
Twitter Icon
X
吹き出しを描いたアイコン
サポートへのお問い合わせ