目的	外部システムとBIZTELを連携することで、電話番号／電話番号グループごとの着信通話に関するレポートの集計値を外部システムに連携することが可能です。
対象プラン
用語	【WebAPI】 汎用的なWeb技術を利用し、インターネットを介して外部システムとの連携を容易にする仕組みです。 外部システムごとにWebAPIで用いるパラメーターは異なり、各システムで仕様を公開しています。 【BIZTEL API】 BIZTELが提供するAPIサービスの総称です。 外部システムからBIZTELに対し、実行処理や履歴取得などを行うパラメーターが用意されています。
ポイント	・本機能は、BIZTELバージョン 3.13.X 以降で利用可能です。 ・本機能をご利用いただく場合、「レポート取得API」のオプション契約が必要です。 ・「電話番号グループ」単位の集計は、「電話番号グループ」のオプション契約が必要です。 詳細は「1.電話番号グループ」を参照ください。 ・月間のAPIリクエスト数、APIレスポンスオブジェクト数の上限は、各100,000件となります。 （「エージェントステータス参照」に関する制限かつBIZTEL API全体での上限となります。） ・電話番号レポート：着信の集計対象や詳細は「5.電話番号レポート：着信」を参照ください。 ・API定義ファイルを「システム設定」メニューからダウンロードすることができます。 ダウンロード画面の詳細は「1.システム設定」をご参照ください。

・本マニュアルはHTML/PHP(PCRE正規表現等)/WebAPIの基礎的な技術知識がある、WEB系開発者様やCRMベンダー様を対象にしております。

目次

1. レポート取得APIの基本機能

2.流入経路レポートの取得

2.1 API基本仕様

2.2 リクエスト方式

2.3 リクエストパラメータ

2.4 レスポンスコード

2.5 ヘッダー

2.6 レスポンスボディ

2.7 レスポンスパラメータ

2.8 エラー仕様

3.日時・曜日別レポートの取得

3.1 API基本仕様

3.2 リクエスト方式

3.3 リクエストパラメータ

3.4 レスポンスコード

3.5 ヘッダー

3.6 レスポンスボディ

3.7 レスポンスパラメータ

3.8 エラー仕様

4.注意事項

1. レポート取得APIの基本機能

レポート取得APIは、BIZTELと外部システムの連携により、外部システムからBIZTELの各種レポートの内容を取得可能とします。

取得可能なレポートは以下となります。

・コールセンターレポート：着信（8.レポート取得API（コールセンターレポート：着信）※3.10.X以降）を参照ください

・コールセンターレポート：発信（9.レポート取得API（コールセンターレポート：発信）※3.10.X以降）を参照ください

・エージェントレポート：着信（10.レポート取得API（エージェントレポート：着信）※3.10.X以降）を参照ください

・エージェントレポート：発信（11.レポート取得API（エージェントレポート：発信）※3.10.X以降）を参照ください

・電話番号レポート：着信（本マニュアルの範囲です）

・電話番号レポート：発信（12.レポート取得API（電話番号レポート：発信）※3.10.X以降）を参照ください

2.流入経路レポートの取得

2.1 API基本仕様

URI schemeは以下となります。

2.2 リクエスト方式

流入経路レポートのデータ取得時のリクエスト方式は以下となります。

2.3 リクエストパラメータ

流入経路レポートのリクエストパラメータは以下となります。

● 実行形式

macOSのターミナルにて、curlコマンド実行する場合の例

curl -X GET --header "Accept: application/json" --header "Authorization: Token ★事前に払い出したAPIトークン★" "https://★契約BIZETLサーバFQDN★:8000/public/api/v1/report/phone_number_incoming/summary?★リクエストパラメータ★"

● 入力サンプル

curl -X GET --header "Accept: application/json" --header "Authorization: Token d6357156532a940baea9e0012bab1e55e9e4cb51e6c9a352e16206d053303929c9e52cd4609a4bbf" "https://sxxxxxxxxxxxx.u.biztel.jp:8000/public/api/v1/report/phone_number_incoming/summary?phone_number_ids=10001,10002&include_repeated_caller_number=1&include_repeated_caller_number_excluding_aban=1&repeated_calls_threshold=2"

2.4 レスポンスコード

レポート取得APIのレスポンスコードは以下となります。

2.5 ヘッダー

レポート取得APIのヘッダー情報は以下となります。

{
  HTTP/1.1 200 OK
  Content-Type: application/json
  Transfer-Encoding: chunked
  Connection: keep-alive
  Vary: Accept-Encoding
  Cache-Control: no-cache, private
  Date: Thu, 11 Dec 2025 14:29:03 GMT
  X-Account-ID: 1
  X-RateLimit-Limit: 300
  X-RateLimit-Remaining: 299
  Access-Control-Allow-Origin: *
  Access-Control-Allow-Methods: GET, POST, PUT, DELETE
  Access-Control-Allow-Headers: Origin, Content-Type, Authorization, X-Auth-Token, x-xsrf-token
  Access-Control-Allow-Credentials: true
  X-Robots-Tag: noindex
  X-Frame-Options: DENY
  X-Content-Type-Options: nosniff
  X-XSS-Protection: 1; mode=block
  Strict-Transport-Security: max-age=31536000; includeSubDomains
  Referrer-Policy: no-referrer
  Permissions-Policy: cross-origin-isolated=(self), sync-xhr=(self), accelerometer=(), autoplay=(), camera=(), display-capture=(), document-domain=(), encrypted-media=(), fullscreen=(), geolocation=(), gyroscope=(), keyboard-map=(), magnetometer=(), midi=(), payment=(), picture-in-picture=(), publickey-credentials-get=(), screen-wake-lock=(), usb=(), web-share=(), xr-spatial-tracking=(), clipboard-read=(), clipboard-write=(), hid=(), idle-detection=(), serial=()
  Cache-Control: no-store
  Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline'; font-src 'self' data:; script-src 'self' 'unsafe-inline'; media-src 'self' blob:; connect-src 'self' blob: ws: wss: data:;; img-src 'self' data: blob:;
  Cache-Control: no-store
  Content-Encoding: gzip
}

2.6 レスポンスボディ

流入経路レポートのレスポンスボディは以下となります。

● 取得に成功した場合の例

[
    {
        "phone_number_id": "10001",
        "phone_number": "03XXXXXXXX",
        "phone_number_name": "デフォルト電話番号",
        "phone_number_group_id": "0",
        "phone_number_group_name": "",
        "extension": "",
        "extension_name": "",
        "extension_id": "",
        "total_incoming": "0",
        "response_count": "0",
        "unique_caller_count": "0",
        "unique_caller_count_excluding_aban": "0",
        "repeat_caller": "0",
        "repeat_caller_excluding_aban": "0",
        "talk_min": "00:00:00",
        "talk_avg": "00:00:00",
        "talk_max": "00:00:00",
        "total_talk": "00:00:00"
    }
]

● 取得に失敗した場合の例

{
  "name": "AuthenticationException",
  "type": "UNAUTHENTICATED",
  "exception_id": null,
  "message": "Unauthenticated: cause=unknown auth method.",
  "messages": null,
  "reason": "Unauthenticated: cause=unknown auth method."
}

2.7 レスポンスパラメータ

流入経路レポートのレスポンスパラメータは以下となります。

2.8 エラー仕様

3.日時・曜日別レポートの取得

3.1 API基本仕様

URI schemeは以下となります。

3.2 リクエスト方式

日時・曜日別レポートのデータ取得時のリクエスト方式は以下となります。

3.3 リクエストパラメータ

日時・曜日別レポートのリクエストパラメータは以下となります。

● 実行形式

macOSのターミナルにて、curlコマンド実行する場合の例

curl -X GET --header "Accept: application/json" --header "Authorization: Token ★事前に払い出したAPIトークン★" "https://★契約BIZETLサーバ★:8000/public/api/v1/report/phone_number_incoming/datewise?★リクエストパラメータ★"

● 入力サンプル

curl -X GET --header "Accept: application/json" --header "Authorization: Token d6357156532a940baea9e0012bab1e55e9e4cb51e6c9a352e16206d053303929c9e52cd4609a4bbf" "https://sxxxxxxxxxxxx.u.biztel.jp:8000/public/api/v1/report/phone_number_incoming/datewise?phone_number_ids=10001,10002&category=1&include_repeated_caller_number=1&include_repeated_caller_number_excluding_aban=1&repeated_calls_threshold=2&grouptype=3"

3.4 レスポンスコード

レポート取得APIのレスポンスコードは以下となります。

3.5 ヘッダー

レポート取得APIのヘッダー情報は以下となります。

{
 HTTP/1.1 200 OK
 Content-Type: application/json
 Transfer-Encoding: chunked
 Connection: keep-alive
 Vary: Accept-Encoding
 Cache-Control: no-cache, private
 Date: Thu, 11 Dec 2025 17:20:16 GMT
 X-Account-ID: 1
 X-RateLimit-Limit: 300
 X-RateLimit-Remaining: 299
 Access-Control-Allow-Origin: *
 Access-Control-Allow-Methods: GET, POST, PUT, DELETE
 Access-Control-Allow-Headers: Origin, Content-Type, Authorization, X-Auth-Token, x-xsrf-token
 Access-Control-Allow-Credentials: true
 X-Robots-Tag: noindex
 X-Frame-Options: DENY
 X-Content-Type-Options: nosniff
 X-XSS-Protection: 1; mode=block
 Strict-Transport-Security: max-age=31536000; includeSubDomains
 Referrer-Policy: no-referrer
 Permissions-Policy: cross-origin-isolated=(self), sync-xhr=(self), accelerometer=(), autoplay=(), camera=(), display-capture=(), document-domain=(), encrypted-media=(), fullscreen=(), geolocation=(), gyroscope=(), keyboard-map=(), magnetometer=(), midi=(), payment=(), picture-in-picture=(), publickey-credentials-get=(), screen-wake-lock=(), usb=(), web-share=(), xr-spatial-tracking=(), clipboard-read=(), clipboard-write=(), hid=(), idle-detection=(), serial=()
 Cache-Control: no-store
 Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline'; font-src 'self' data:; script-src 'self' 'unsafe-inline'; media-src 'self' blob:; connect-src 'self' blob: ws: wss: data:;; img-src 'self' data: blob:;
 Cache-Control: no-store
 Content-Encoding: gzip
}

3.6 レスポンスボディ

日時・曜日別レポートのレスポンスボディは以下となります。

● 取得に成功した場合の例

[
   {
       "total_incoming": "0",
       "response_count": "0",
       "unique_caller_count": "0",
       "unique_caller_count_excluding_aban": "0",
       "repeat_caller": "0",
       "repeat_caller_excluding_aban": "0",
       "talk_min": "00:00:00",
       "talk_avg": "00:00:00",
       "talk_max": "00:00:00",
       "total_talk": "00:00:00",
       "time": "00:00"
   }
]

● 取得に失敗した場合の例

{
 "name": "AuthenticationException",
 "type": "UNAUTHENTICATED",
 "exception_id": null,
 "message": "Unauthenticated: cause=unknown auth method.",
 "messages": null,
 "reason": "Unauthenticated: cause=unknown auth method."
}

3.7 レスポンスパラメータ

日時・曜日別レポートのレスポンスパラメータは以下となります。

3.8 エラー仕様

4.注意事項

レポート取得APIのバースト制御について

レポート取得APIのバースト制御は、システム設定>ライセンス設定>バースト時の上限値（履歴取得API等）をご確認ください。
※毎秒10回のアクセスとなります。

APIリクエスト数の消費仕様について

BIZTEL API（レポート取得API）のライセンス消費数は以下となります。

リクエストに対する返却オブジェクトが存在しない場合

リクエストを実行した結果、返却されるオブジェクトが存在しなかった場合は「APIレスポンスオブジェクト数」を消費しません。