APIを使用してファックスを送信するにはどうすればよいですか？

更新 2026年09月11日 17:07

この機能を使用できるのは誰ですか？

Enterprise プランで利用可能です。

すべてのメンバー。

APIを使用してファックスを送信するには、まず必要なファイルをアップロードし、次にそれらのファイルをファックス送信用に準備してから、送信をスケジュールする必要があります。

ファックスがスケジュールされたら、HTTPサーバーを実装し、webhookの仕組みを活用できます。この方法により、ファックスの送信が成功した場合と失敗した場合の両方でHTTPメッセージが送信されることが保証されます。

注：初回認証プロセスを完了し、APIへのログインに成功していることを確認してください。詳細な手順については、こちらのガイドをご参照ください。

ステップ1: ファックス送信するファイルをアップロードする

ファイルをアップロードするには、以下のURLにHTTP POSTリクエストを送信します: https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' or 'tiff']

リクエストには、以下のヘッダーを必ず含めてください:

- Content-Type:
```
multipart/form-data
```

- Authorization:
```
Bearer [access token]
```

- x-fax-clientid:
```
[client ID]
```

本文には:

{
  "fax_file": [file]
}

‍

以下の例では、「self」を現在ログインしているユーザーの一意の識別子を表すユーザーIDとして使用しています:

FAX.PLUS-Send-Fax-API-2.png

FAX.PLUS-Send-Fax-API-3.png

ファイルのアップロードが正常に完了すると、Fax.Plus上のファイルの一時保存場所へのパスが提供されます。

ステップ2: APIを使用してファックスを送信する

アップロードが完了したら、ファックスの送信準備を開始できます。この処理を開始するには、以下のURLにHTTP POSTリクエストを実行します:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox

リクエストには、以下のヘッダーを必ず含めてください:

- Authorization:
```
Bearer [access token]
```
- x-fax-clientid:
```
[client ID]
```

リクエスト本文には:

{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}

FAX.PLUS-Send-Fax-API-4.png

ファックスのスケジュール設定が正常に完了すると、Outbox IDが提供されます。このIDは、ファックスが実際に送信される前に、内容の変更や削除を行うために使用できます。

注: 弊社のAPIでは、ファックスには複数のIDが関連付けられています。これは、ファックス送信が非同期で行われるための仕様です。具体的には、送信ファックスは2つの異なるIDによって識別されます。1つはファックスが正常に送信されるまで機能するOutbox ID、もう1つはファックスが正常に送信された後にそのファックスの確定的な識別子となるFax IDです。

ステップ3: Webhookを使用して送信したファックスのステータスを確認する

ファックスのスケジュール設定後、outboxまたは送信済みカテゴリーにあるファックスの一覧を確認することで、そのステータスを監視できます。

あるいは、HTTPサーバーを構築してWebhookを使用するオプションもあります。これにより、ファックスの送信が成功した場合、または送信に失敗した場合にHTTPメッセージが送信されるようになります。

以下の手順に従ってWebhookを設定してください:

Fax.Plusアカウントにログインし、ダッシュボードの設定セクションに移動します。
連携タブの下で、WebHooksのボックスを見つけます。
着信ファックスを見つけます。Webhookを変更するには管理をクリックします。

Webhookを設定すると、発信ファックスの処理が完了した際に以下の通知を受け取ります:

{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.example.com/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxxxx",
"cost": 1,
"status": "success"
}
}

このメッセージには、送信時刻が記載され、「status」フィールドによりファックス送信の成功が示され、一意のファックスIDが提供されます。このファックスIDを使用して、ファックスファイルを取得したり、ファックス確認レポートを取得したりできます。

Need Support?