APIを使用してファックスを送信するには、まず必要なファイルをアップロードし、次にそれらのファイルをファックス送信用に準備してから、送信をスケジュールする必要があります。
ファックスがスケジュールされたら、HTTPサーバーを実装し、webhookの仕組みを活用できます。この方法により、ファックスの送信が成功した場合と失敗した場合の両方でHTTPメッセージが送信されることが保証されます。
注：初期認証プロセスを完了し、APIに正常にログインしていることを確認してください。詳細な手順については、ガイドをこちらからご確認ください。
ファイルをアップロードするには、次の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]
}
次の例では、現在ログインしているユーザーの一意の識別子を表すために、user IDとして「self」を使用しています：
ファイルが正常にアップロードされると、Fax.Plus上のファイルの一時的な保存場所へのパスが返されます。
アップロードが完了したら、faxの送信準備を開始できます。処理を開始するには、次の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のスケジュールが正常に完了すると、Outbox IDが発行されます。このIDは、faxが実際に送信される前に、内容を変更したり削除したりする際に使用できます。
注：当社のAPIでは、faxは複数のIDに関連付けられます。これは、faxの送信が非同期で行われる設計になっているためです。具体的には、送信するfaxは2つの異なるIDで識別されます。1つは、faxが正常に送信されるまで使用されるOutbox ID、もう1つは、faxが正常に送信された後にそのfaxの確定的な識別子となるFax IDです。
faxをスケジュールした後は、アウトボックスまたは送信済みカテゴリにあるfaxの一覧を確認することで、ステータスを監視できます。
または、HTTPサーバーを用意してWebhookを使用することもできます。これにより、faxが正常に送信されたとき、または送信に失敗したときに、HTTPメッセージが送信されます。
Webhookを設定する手順：
- Fax.Plusアカウントにログインし、ダッシュボードの設定 セクションに移動します。
- 連携タブで、WebHooksのボックスを探します。
-
受信faxと受信faxを探します。管理をクリックしてWebhookを変更します。
Webhookを設定すると、送信faxが処理された際に次の通知を受信します：
{
"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"
}
}このメッセージには、送信時刻、faxの送信が成功したかどうか（「status」フィールドで示されます）、および一意のfax IDが含まれます。このfax IDは、faxファイルの取得やfaxの送信確認レポートの取得に使用できます。