API を使用して Fax を送信するには、まず必要なファイルをアップロードする必要があります。 次にファックスと送信スケジュールのファイルを準備します
FAXが予定されていると、HTTPサーバーを実装し、Webhookメカニズムを活用できます。 このアプローチにより、ファックスの送信が成功したときと送信に失敗した場合の両方で HTTP メッセージが送信されることが保証されます。
メモ: 初期認証プロセスが完了し、API に正常にログインしたことを確認してください。 For additional instructions, refer to our guide here.
ファイルをアップロードするには、次の URL に HTTP POST リクエストを開始します。 https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' or 'tiff']
以下のヘッダーをリクエストに含めてください:
-
- Content-Type:
multipart/form-data
- Content-Type:
-
- 認証:
ベアラーformat@@0
- 認証:
-
- x-fax-clientid:
[クライアント ID]
- x-fax-clientid:
体の場合:
{
"fax_file": [file]
}
次の例では、現在ログインしているユーザーの一意のIDを表すために、ユーザー ID として "self" を使用します。
ファイルが正常にアップロードされると、Fax.Plus 上のファイルの一時的な場所へのパスが表示されます。
アップロードが完了すると、 送信用のファックスの準備を始めることができます。 To initiate the process, perform an HTTP POST request to the following URL:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox
Make sure to include the following headers in your request:
-
- 認証:
ベアラーformat@@0
- x-fax-clientid:
[クライアント ID]
- 認証:
リクエストボディ:
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
FAXのスケジュールが正常に完了すると、Outbox IDが提供されます。 このIDは、実際に送信される前に、変更やFAXの削除に利用できます。
メモ: FaxはAPIと複数のIDに関連付けられています。 ファックス送信が非同期的に動作するため、この設計が実施されています。 具体的には、送信する Fax は、2 つの異なる ID によって識別されます: 送信トレイの ID は、ファックスが正常に送信されるまでその目的を果たします。 そして Fax ID は、送信に成功すると、Fax の決定的な識別子となります。
FAXをスケジュールした後 アウトボックス または 送信カテゴリにあるファクスのリストを確認することで、ステータスを監視できます。
あるいは、HTTPサーバーを確立し、Webhookを使用するオプションがあります。 これにより、FAXが正常に送信されたとき、または送信に失敗した場合に送信されるHTTPメッセージがトリガーされます。
Webhookを設定するには、以下の手順に従ってください:
- Fax.Plus アカウントにログインし、ダッシュボードの Profileセクションに移動します。
- 統合のタブの下で、Web フックのボックスを見つけます。
- Find Incoming Faxes and Incoming Faxes. Manage をクリックして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"
}
}
このメッセージは送信時間を提供します。 は、("status" フィールドを介して) Fax 送信の成功を示し、独自の Fax IDを提供します。 このFAXIDは、 ファックスファイル または ファックス確認レポートを取得するために利用することができます。