開発者

GET/v3/fax_outbox

送信ファクスジョブの一覧取得

ファクスを再送信せずに、送信記録を確認して複数ページの結果を照合します。

このページの内容
  1. 送信ファクスジョブの一覧取得
  2. ジョブ記録の確認
  3. 複数ページの結果を安全に照合する
  4. プライバシーと再試行

送信ファクスジョブの一覧取得

有効化された MultiTEL API アカウントを使用し、設定済みの認証情報と IP 制限に従って HTTPS で接続してください。このエンドポイントは、認証されたアカウントに属する送信ファクス記録を一覧表示します。一覧の取得によってファクスが送信または再送信されることはありません。

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode search=0123456789abcdef0123456789abcdef \
  https://api.multitel.net/v3/fax_outbox
送信トレイのクエリパラメーター
パラメーター必須説明
pageいいえ1 から始まるページ番号。既定値:1。
limitいいえページあたりの記録数。既定値:25、最大値:100。正の整数を指定してください。
searchいいえ送信元番号、送信先番号、ジョブの UUID を検索します。先頭と末尾の空白は除去されます。状態や結果テキストは検索対象になりません。

このハンドラーは date_from および date_to による絞り込みに対応していません。ポータルの送信トレイには追加のフィルターがありますが、それらをこの API リクエストに転用しないでください。結果は作成日時の新しい順に並びます。ID による補助的な並べ替えやスナップショットカーソルはありません。

ジョブ記録の確認

HTTP の結果と JSON の status.code の両方を確認してください。成功時のレスポンスには response.faxes と response.pagination が含まれます。例では架空のデータを使用しています。送信トレイが空の場合は、空の faxes 配列が返され、total は 0、total_pages は 0 になります。

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 13,
      "uuid": "0123456789abcdef0123456789abcdef",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "status": "queued",
      "pages_requested": 3,
      "pages_sent": 0,
      "cost": "0.07500",
      "result_text": "",
      "created_at": "2026-10-01 12:00:00",
      "sent_at": null,
      "updated_at": "2026-10-01 12:00:00"
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id は数値の記録 ID です。uuid は表示用のジョブ識別子です。新規送信時は send_fax が返すジョブ ID を使用し、その ID を保存して 状態のポーリング に使用してください。一覧には古い記録も含まれるため、すべての行が同じ送信エンドポイントを通じて作成されたとは限りません。

status と result_text には、記録された処理状態とメッセージが格納されています。この一覧では、それらを配信状態の網羅的な列挙型に正規化しません。キュー待ちはキュー待ちを意味し、配信済みではありません。重要な文書については、配信済みと判断したり重複して送信したりする前に、受信者に受領を確認してください。

pages_requested と pages_sent は数値で表される枚数です。cost は保存されている値をそのまま保持し、フォールバック値は文字列の 0.00 です。受信トレイの料金と同じ JSON 型であるとは限りません。キュー待ちの記録にも、すでに見積額が含まれている場合があります。その値も一覧の項目も、最終的な請求を確定するものではありません。

created_at、sent_at、updated_at は、タイムゾーンのオフセットを含まない、サーバー側の書式で保存された値です。sent_at は null の場合があります。この一覧には、別の状態確認エンドポイントが返す Webhook の状態フィールドは含まれません。

複数ページの結果を安全に照合する

pagination.page、limit、total、total_pages に従ってページを取得してください。最終ページを超えるページは空の場合があります。閲覧中に新しいジョブが追加されると、項目が別のページに移動することがあります。複数ページの結果をまとめる際は、ジョブ識別子を保持してください。このエンドポイントは、固定されたスナップショットを保証しません。

プライバシーと再試行

送信トレイの記録には、非公開の電話メタデータが含まれています。閲覧できる人を制限し、レスポンス全体をログに記録しないでください。一覧に項目がないことは、送信リクエストが失敗した証拠にはなりません。再送信する前に、保存したジョブ ID とポータルの送信トレイを確認してください。新たに送信すると、課金対象となり得る別のファクスが作成される可能性があります。ワーカー処理、課金、コールバック、データ保持に関する最終的な保証内容は、引き続きレビュー中です。