秒速FAXPlus

050-6861-1726

9:00~18:00 土・日・祝日を除く

  • 電話でお問い合わせ

トップページ > 機能一覧 > FAX受信API

API機能

システム開発用FAX受信APIを利用することで、秒速FAX Plusで受信したデータを取得することが出来ます。APIを実行するサーバーのIPアドレスを登録することで、システム開発用APIの利用が可能となります。

API名 概要
FAX受信ログ API 最新50件のFAX受信ログを取得します。
FAX受信PDF API FAX受信データのPDFを取得します。

FAX受信ログ API

FAX受信ログ APIは、秒速FAX Plusの受信ログから最新50件のデータを取得します。

リクエストURL

ご契約後管理画面より参照

リクエストパラメータ

なし

レスポンスフィールド

種類 項目名 フィールド名 説明
全体情報 ステータス status 成功時:0
失敗時:1
エラーメッセージ ErrorMsg 失敗時、エラー内容を出力します
FAX情報 FAX情報の配列 Results FAX情報を配列として保持します
受信日時 Results/receiveDate FAXを受信した日時
受信元FAX番号 Results/faxNumber  
枚数 Results/
page
FAXを受信した枚数
送信元FAX番号 Results/
sendNumber
非通知の場合ブランク
PDF番号 Results/pdfId PDF取得APIで利用します

エラーメッセージ

HTTPステータスコードが200であれば正常終了、それ以外はエラー終了となります。 エラー内容は、HTTPステータスコードまたは、statusフィールドとErrorMsgフィールドから判断できます。

HTTPステータスコード status ErrorMsg 説明
200 0   正常終了
400 1 ERR_NO_DATA ユーザー情報が取得できなかった場合
400 1 ERR_ACCESS_INTERVAL 60秒以内に再アクセスした場合
403     リクエストが許可されていない(固定IPが登録されていない)場合
404     指定されたURLが存在しない場合
500 1 ERR_SERVER_ERR サーバーエラーによりデータを取得できなかった場合

フォーマット

JSON

文字コード

UTF-8

利用制限

  • 一度に取得できるレコードは50件までです。
  • 前回のリクエストから次のリクエストまでの間隔を60秒以上開けて下さい。
    60秒以内に再アクセスした場合は、エラーとなります。

レスポンスの例

正常終了の場合、JSON形式でデータを返却します。


{"status":0,
  "ErrorMsg":"",
  "Results":[
    {
      "receiveDate":"2014-04-16 03:09:00",
      "faxNumber":"0368680000",
      "page":"1",
      "senderNumber":"0368680000",
      "pdfId":"dG8vc2E9NTTTODQ9"
    },
    {
      "receiveDate":"2014-04-16 03:08:00",
      "faxNumber":"0368680000",
      "page":"1",
      "senderNumber":"0368680000",
      "pdfId":"dG8vc2E9NTTTODQ8"
    },
    {
      "receiveDate":"2014-04-16 03:07:00",
      "faxNumber":"0368680000",
      "page":"1",
      "senderNumber":"0368680000",
      "pdfId":"dG8vc2E9NTTTODQ7"
    },
    {
      "receiveDate":"2014-04-16 03:06:00",
      "faxNumber":"0368680000",
      "page":"1",
      "senderNumber":"0368680000",
      "pdfId":"dG8vc2E9NTTTODQ6"
    },
    {
      "receiveDate":"2014-04-16 03:05:00",
      "faxNumber":"0368680000",
      "page":"1",
      "senderNumber":"0368680000",
      "pdfId":"dG8vc2E9NTTTODQ5"
    }
  ]
}
    

FAX受信PDF API

FAX受信PDFAPIは、インターネットFAXの受信PDFから指定したPDFデータを取得します。

リクエストURL

ご契約後管理画面より参照

リクエストパラメータ

項目名 パラメータ名 必須 説明
PDF番号 pdfId 必須 FAX受信ログAPIで取得したPDF番号(Results/pdfId)を指定

レスポンスフィールド

処理が成功した場合、以下の仕様でPDFデータを返却します。

Content-Type: application/pdf
Content-Disposition: attachment; filename="xxx.pdf" 

処理が失敗した場合、JSON形式で以下のエラーを返却します。

項目名 フィールド名 説明
ステータス status 必ず1となります
エラーメッセージ ErrorMsg エラー内容を出力します

エラーメッセージ

HTTPステータスコードが200であれば正常終了、それ以外はエラー終了となります。 エラー内容は、HTTPステータスコードまたは、statusフィールドとErrorMsgフィールドから判断できます。

HTTPステータスコード status ErrorMsg 説明
200     正常終了(PDFを返却)
400 1 ERR_NO_DATA ユーザー情報が取得できなかった場合
400 1 ERR_ACCESS_INTERVAL 1秒以内に再アクセスした場合
400 1 ERR_PDF_ID PDF番号が指定されていない、または不正な場合
400 1 ERR_NO_PDF 指定のPDFが存在しないか、削除済みの場合
403     リクエストが許可されていない(固定IPが登録されていない)場合
404     指定されたURLが存在しない場合
500 1 ERR_SERVER_ERR サーバーエラーによりデータを取得できなかった場合
503 1 ERR_SERVER_BUSY 規定の同時アクセス数を超えた場合

フォーマット

成功時: PDFデータ
失敗時: JSON

文字コード

UTF-8

利用制限

  • 一度に指定できるPDF番号は1件までとなります。
  • 前回のリクエストから次のリクエストまでの間隔を1秒以上開けて下さい。
    1秒以内に再アクセスした場合は、エラーとなります。

リクエストの例

ご契約後管理画面より参照

レスポンスの例

正常終了の場合、PDF形式でデータを返却します。
失敗した場合、以下のようにJSON形式でデータを返却します。

{"status":1, "ErrorMsg":"ERR_NO_PDF"}

ページのトップへ戻る