ウェブフックを使用して、送信または受信した fax のステータスを確認するにはどうすればよいですか?

この機能を利用できるのは?

Enterprise プランでご利用いただけます。

Web アプリのオーナーと管理者がアクセスできます。

新機能:ウェブフックがアップデートされました 
ウェブフックの設定、配信ログ、イベントのリプレイ、署名検証が改善されました。2026年8月31日より前にウェブフックを設定している場合、既存のエンドポイントは引き続き動作しますが、2027年1月15日までに移行する必要があります。移行手順をご確認ください。

Webhook を使用すると、送信ファックスと受信ファックスに関するリアルタイムの更新情報を Fax.Plus から直接受け取れます。Webhook を設定することで、ファックス送信の監視を自動化し、ステータスの更新を既存のシステムに統合できます。

開発者向けリファレンス: イベントタイプ、ペイロードの構造、署名の検証など、技術的な詳細については、Webhookに関するFax.Plus APIドキュメントをご覧ください。

ウェブフックの設定

  1. Webhooksペインを開きます:
    • Fax.Plusアカウントにログインします。
    • 設定の下にある連携セクションに移動します。
    • Webhooksを探して管理をクリックします。
  2. エンドポイントを追加します:
    • エンドポイントを追加をクリックし、イベントを受信するサーバー上の絶対URLを入力します。
    • 受信するイベントを選択します。すべてのイベントを購読するか、
      イベントカタログから必要なものだけを選択できます。
    • 任意:ファックス番号でフィルターします。お持ちのファックス番号を1つ以上関連付けると、
      それらの番号に関するイベントのみを受信します。
  3. ステータスの更新を受信します

    • 設定が完了すると、ファックスのステータスが
      変わるたびに、Fax.Plusは、指定したURLにWebhookを送信します。
    • Webhookのペイロードには、ファックスID、ステータス、タイムスタンプ、
      受信者情報などの重要な詳細が含まれます。

    注: hook.idがdata.idと等しくない場合、そのファックスは再試行されています。hook.idがdata.idと等しい場合は、そのファックスが初めて送信されていることを示します

  4. 署名を検証します
    • 作成したエンドポイントごとに署名シークレットが自動的に作成され、これを使ってすべての受信リクエストを検証できます。詳しくはWebhook署名の検証をご覧ください。
  5. (任意)送信元IPアドレスを検証します:
    • 受信したWebhookが、当社の許可済みIPアドレスの一覧から送信されていることを確認できます:
      • 52.215.16.239
      • 54.216.8.72
      • 63.33.109.123
      • 2a05:d028:17:8000::/56

トラブルシューティングとモニタリング

  • ログと可観測性: Webhookパネルでは、すべてのイベントと、配信に成功したかどうかを確認できます。
  • 再試行: 配信に失敗した場合、Webhookは自動的に再試行されます。
  • リプレイ: パネルから手動で再試行を実行したり、選択した期間内の過去のイベントをリプレイしたりすることもできます。
この記事は役に立ちましたか?
1人中0人がこの記事が役に立ったと言っています
このセクションの他の記事