API機能

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

API名	概要
FAX送信ログAPI	最新50件のFAX送信ログを取得します。
FAX送信PDFAPI	FAX送信PDFを取得します。

FAX送信ログAPI

FAX送信ログAPIは、インターネットFAXの送信ログから最新50件のデータを取得します。

リクエストURL

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

リクエストパラメータ

なし

レスポンスフィールド

種類	項目名	フィールド名	説明
全体情報	ステータス	status	成功時：0 失敗時：1
全体情報	エラーメッセージ	ErrorMsg	失敗時、エラー内容を出力します
FAX情報	FAX情報の配列	Results	FAX情報を配列として保持します
	送信日時	Results/ sendDate	FAXを送信した日時
	FAX送信アドレス	Results/ account
	枚数	Results/ page	FAXを送信した枚数
	送信先FAX番号	Results/ sendNumber
	PDF番号	Results/ pdfId	PDF取得APIで利用します
	送信ステータス	Results/ sendStatus	送信成功時：0 送信失敗時：1
	送信失敗理由	Results/ reason	送信失敗時、エラー内容を出力します

エラーメッセージ

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":[
    {
      "sendDate":"2014-04-16 03:09:00",
      "account":"fax000000",
      "page":"1",
      "sendNumber":"0368680000",
      "pdfId":"dG8vc2E9NTTTODQ9",
      "sendStatus":"0",
      "reason":""
    },
    {
      "sendDate":"2014-04-16 03:08:00",
      "account":"fax000000",
      "page":"0",
      "sendNumber":"0368680000",
      "pdfId":"",
      "sendStatus":"1",
      "reason":"\u5fdc\u7b54\u7121\u3057\uff08\u30bf\u30a4\u30e0\u30a2\u30a6\u30c8\uff09"
    },
    {
      "sendDate":"2014-04-16 03:07:00",
      "account":"fax000000",
      "page":"1",
      "sendNumber":"0368680000",
      "pdfId":"dG8vc2E9NTTTODQ7",
      "sendStatus":"0",
      "reason":""
    },
    {
      "sendDate":"2014-04-16 03:06:00",
      "account":"fax000000",
      "page":"1",
      "sendNumber":"0368680000",
      "pdfId":"dG8vc2E9NTTTODQ6",
      "sendStatus":"0",
      "reason":""
    },
    {
      "sendDate":"2014-04-16 03:05:00",
      "account":"fax000000",
      "page":"1",
      "sendNumber":"0368680000",
      "pdfId":"dG8vc2E9NTTTODQ5",
      "sendStatus":"0",
      "reason":""
    }
  ]
}

FAX送信PDFAPI

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ステータスコード	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"}

ページのトップへ戻る