目的	外部システムとBIZTELを連携することで、エージェントの窓口発信に関する通話レポートの集計値を外部システムに連携することが可能です。
対象プラン
用語	【WebAPI】 汎用的なWeb技術を利用し、インターネットを介して外部システムとの連携を容易にする仕組みです。 外部システムごとにWebAPIで用いるパラメーターは異なり、各システムで仕様を公開しています。 【BIZTEL API】 BIZTELが公開するAPIを示します。 外部システムからBIZTELに対して実行処理や履歴などの取得を行うことができるパラメーターが用意されています。 （エージェントステータス更新APIはBIZTEL APIの1つとなります。)
ポイント	・本機能は、BIZTELバージョン 3.10.X 以降で利用可能です。 ・本機能をご利用いただく場合、「レポート取得API」のライセンス契約が必要です。 ・月間のAPIリクエスト数、APIレスポンスオブジェクト数の上限は、各100,000件となります。 （「エージェントステータス参照」に関する制限かつBIZTEL API全体での上限となります。） ・エージェントレポート：発信の集計対象や詳細は「5.エージェントレポート：発信（3.10.X以降）」を参照ください。

・本マニュアルは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 エラー仕様

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

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

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

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

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

・エージェントレポート：着信（10.レポート取得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 ★払い出しトークン★" "https://★契約BIZTELサーバFQDN★:8000/public/api/v1/report/agent_outbound/summary?★リクエストパラメータ★"

● 入力サンプル

curl -X GET --header "Accept: application/json" --header "Authorization: Token d6357156532a940baea9e0012bab1e55e9e4cb51e6c9a352e16206d053303929c9e52cd4609a4bbf"
"https://sxxxxxxxxxxxx.u.biztel.jp:8000/public/api/v1/report/agent_outbound/summary?account_ids=10001,10002,10003&queue_ids=10001,10002,10003&category=0"

2.4 レスポンスコード

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

2.5 ヘッダー

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

{
"Access-Control-Allow-Credentials": "true"
"Access-Control-Allow-Headers": "Origin, Content-Type, Authorization, X-Auth-Token, x-xsrf-token"
"Access-Control-Allow-Methods": "GET, POST, PUT, DELETE"
"Access-Control-Allow-Origin": "*"
"Cache-Control": "no-cache, private"
"Cache-Control": "no-store"
"Cache-Control": "no-store"
"Connection": "keep-alive"
"Content-Encoding": "gzip"
"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:;; img-src 'self' data": "blob:;"
"Content-Type": "application/json"
"Date": "Wed, 22 Mar 2023 01:49:58 GMT"
"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=()"
"Referrer-Policy": "no-referrer"
"Server": "nginx"
"Strict-Transport-Security": "max-age=31536000; includeSubDomains"
"Transfer-Encoding": "chunked"
"Vary": "Accept-Encoding"
"X-Account-ID": "1"
"X-Content-Type-Options": "nosniff"
"X-Frame-Options": "DENY"
"X-RateLimit-Limit": "300"
"X-RateLimit-Remaining": "297"
"X-Robots-Tag": "noindex"
"X-XSS-Protection": "1; mode=block"
}

2.6 レスポンスボディ

サマリーレポートのレスポンスボディは以下となります。

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

{
"account_id": "10003",
"account_name": "USER3",
"account_kana": "デフォルトユーザ3",
"moh_avg": "0",
"moh_max": "0",
"moh_sum": "0",
"post_avg": "0",
"post_max": "0",
"post_cum": "0",
"process_avg": "0",
"process_max": "0",
"process_cum": "0",
"on_hold_count": "0",
"call_cnt": "0",
"connected_cnt": "0",
"abandon_cnt": "0",
"connected_rate": "0",
"talk_time_min": "0",
"talk_time_avg": "0",
"talk_time_max": "0",
"talk_time_sum": "0",
"wait_time_min": "0",
"wait_time_avg": "0",
"wait_time_max": "0",
"wait_time_sum": "0"
}

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

{
"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 エラー仕様