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

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

目次

1.ダッシュボードデータ取得APIの基本機能

2.ダッシュボードデータ取得APIの基本機能について

2.1 リクエスト方式

2.2 リクエストパラメータ

2.3 レスポンスコード

2.4 ヘッダー

2.5 レスポンスボディ

2.6 レスポンスパラメータ

2.7 エラー仕様

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

1.ダッシュボードデータ取得APIの基本機能

エージェントステータス更新APIは、外部システムからBIZTELのエージェントステータスを参照・更新を可能とするAPIです。

動作イメージ図

2.ダッシュボードデータ取得APIの基本機能について

2.1 リクエスト方式

ダッシュボードデータ取得APIを実行する際のリクエスト方式は以下となります。

2.2 リクエストパラメータ

エージェントステータス更新APIのリクエストパラメータは以下となります。

実行例

● 実行形式

macOSのコンソールで実行する場合の例です。

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

● 入力サンプル

例）アカウントID：10001 のステータスを 受付可（account_status_id=9） に変更する。

curl -X GET --header "Accept: application/json" --header "Authorization: Token d6357156532a940baea9e0012bab1e55e9e4cb51e6c9a352e16206d053303929c9e52cd4609a4bbf" "https://sxxxxxxxxxxxx.u.biztel.jp:8000/public/api/v1/dashboard?queue_id=10001&period_type=1"

2.3 レスポンスコード

エージェントステータス更新APIを実行する際のレスポンスコードは以下となります。

2.4 ヘッダー

エージェントステータス更新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,no-store,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: Thu,07 Mar 2024 04:38:18 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: 10 
x-ratelimit-remaining: 9 
x-robots-tag: noindex 
x-xss-protection: 1; mode=block 
}

2.5 レスポンスボディ

エージェントステータス更新APIのレスポンスボディは以下となります。

● 取得成功時の例

[
{
"queue_id": 10001,
"queue_name": "デフォルト窓口",
"period_from_date": "2024-03-06 00:00:00",
"period_to_date": "2024-03-06 00:10:00",
"incoming_number": 0,
"response_number": 0,
"reservation_number": 0,
"reservation_complete_number": 0,
"abandonment_number": 0,
"timeout": 0,
"queueing_count": 0,
"response_time_average": "0.00",
"response_time_maximum": 0,
"hold_time_average": "0.00",
"hold_time_maximum": 0,
"abandonment_time_average": "0.00",
"abandonment_time_maximum": 0,
"response_rate": "0.00",
"call_end_number": 0,
"call_average": "0.00",
"call_maximum": 0,
"call_cumulative": 0,
"post_working_time_average": "0.00",
"post_working_time_maximum": 0,
"post_working_number": 0,
"memo": "string",
"created_at": "2024-03-06 00:11:44",
"updated_at": "2024-03-06 00:11:44",
"version": 1709651504
}
]

● 取得失敗時の例

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

2.6 レスポンスパラメータ

2.7 エラー仕様

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

BIZTEL API（エージェントステータス更新API）のライセンス消費数は以下となります。