※本マニュアルは、BIZTELバージョン 3.10.X以降をご利用のユーザ様向けです。
BIZTELバージョン 3.9.Xまでをご利用の場合は、「4.レポート取得API(コールセンターレポート)※3.9.Xまで」を参照ください。
目的 |
外部システムとBIZTELを連携することで、コールセンター着信に関する通話レポートの集計値を外部システムに連携することが可能です。 |
---|---|
対象プラン |
|
用語 |
【WebAPI】 汎用的なWeb技術を利用し、インターネットを介して外部システムとの連携を容易にする仕組みです。 【BIZTEL API】 BIZTELが公開するAPIを示します。 |
ポイント |
・本機能は、BIZTELバージョン 3.10.X 以降で利用可能です。 ・本機能をご利用いただく場合、「レポート取得API」のライセンス契約が必要です。 ・月間のAPIリクエスト数、APIレスポンスオブジェクト数の上限は、各100,000件となります。 ・管理画面上のコールセンターレポート:着信の集計対象や詳細は「3.コールセンターレポート:着信(3.10.X以降)」を参照ください。 |
・本マニュアルはHTML/PHP(PCRE正規表現等)/WebAPIの基礎的な技術知識がある、WEB系開発者様やCRMベンダー様を対象にしております。
目次
1.レポート取得APIの基本機能
レポート取得APIは、BIZTELと外部システムの連携により、外部システムからBIZTELの各種レポートの内容を取得可能とします。
取得可能なレポートは以下となります。
・コールセンターレポート:着信(本マニュアルの範囲です)
・コールセンターレポート:発信(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は以下となります。
Host | sXXXXXXXXXXXX.u.biztel.jp:8000 | BIZTELサーバアドレスとして指定されたFQDN |
---|---|---|
scheme | HTTPS | - |
2.2 リクエスト方式
サマリーレポートのデータ取得時のリクエスト方式は以下となります。
認証方式 | HTTPメソッド | URI | 備考 |
---|---|---|---|
APIトークン認証方式 | GET | /public/api/v1/report/queue/summary |
APIトークンによるアカウント認証が必要です。 |
2.3 リクエストパラメータ
サマリーレポートの取得で使用するパラメータは以下となります。
パラメータ | 説明 | 備考 | 必須項目 | パラメータ型 | データ型 | 初期値 |
---|---|---|---|---|---|---|
from | 集計開始日時を指定します | 画面での該当項目:集計開始日時 画面での該当項目は必須項目です |
No | query | string |
当日0時 yyyy/mm/dd hh:mm |
to | 集計終了日時を指定します |
画面での該当項目:集計終了日時 |
No | query | string |
翌日0時 (当日の24時) yyyy/mm/dd hh:mm |
category | 集計対象を選択します | 画面での該当項目:集計対象 0:コールセンター 1:業務ラベル |
No | query | integer | 0 |
queue_ids | コールセンターを選択します | 画面での該当項目:コールセンター 集計対象プルダウンでコールセンターを選択時 |
Yes: 集計対象未入力または集計対象プルダウンでコールセンターを選択時 No: 集計対象プルダウンで業務ラベルを選択時 |
query | string | -- |
business_ids | 業務ラベルを選択します | 画面での該当項目:業務ラベル 集計対象プルダウンで業務ラベルを選択時 |
Yes: 集計対象プルダウンで業務ラベルを選択時 No: 集計対象未入力または集計対象プルダウンでコールセンターを選択時 |
query | string | -- |
servicelevel | サービスレベル目標時間 (秒)を選択・入力します | 画面での該当項目:詳細設定・サービスレベル目標時間 (秒) | No | query | integer | 30 |
abanshorttime | ショートアバンダン設定時間 (秒)を選択・入力します | 画面での該当項目:詳細設定・ショートアバンダン設定時間 (秒) | No | query | integer | 30 |
mohshorttime | 保留目標時間 (秒)を選択・入力します | 画面での該当項目:詳細設定・保留目標時間 (秒) | No | query | integer | 30 |
Authorization |
APIトークン認証方式の場合に用います | ''Tokenトークン文字列'の形式で入力します | Yes | header | string | -- |
● 実行形式
macOSのターミナルにて、curlコマンド実行する場合の例
curl -X GET --header "Accept: application/json" --header "Authorization: Token ★払い出しトークン★" "https://★契約BIZTELサーバFQDN★:8000/public/api/v1/report/queue/summary?★リクエストパラメータ★"
● 入力サンプル
curl -X GET --header "Accept: application/json" --header "Authorization: Token d6357156532a940baea9e0012bab1e55e9e4cb51e6c9a352e16206d053303929c9e52cd4609a4bbf" "https://sxxxxxxxxxxxx.u.biztel.jp:8000/public/api/v1/report/queue/summary?&queue_ids=10001&category=0&servicelevel=30&abanshorttime=30&mohshorttime=30"
2.4 レスポンスコード
レポート取得APIのレスポンスコードは以下となります。
HTTP Status Code | Reason | 説明 |
---|---|---|
200 | Successful Operation | 正常終了(成功) |
400 | Bad Request | 不正なリクエスト |
401 | Unauthorized | 認証失敗 |
404 | Not Found | 対象が存在しません |
429 | TooManyRequest | バースト上限の超過 |
500 | Internal Server Error | システム障害 |
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 レスポンスボディ
サマリーレポートのレスポンスボディは以下となります。
● 取得に成功した場合の例
{
"queue_id": "10001",
"queue_name": "デフォルト窓口",
"sip_user_name": "7001",
"business_id": "0",
"business_name": "",
"ent": "0",
"con": "0",
"moh": "0",
"mohshort": "0",
"aban": "0",
"abanshort": "0",
"dump": "0",
"comp": "0",
"tmout": "0",
"waitcall": "0",
"outou": "0.0000",
"svclevcnt": "0",
"svclev": "0.0000",
"conave": "00:00:00",
"mohave": "00:00:00",
"conmax": "00:00:00",
"mohmax": "00:00:00",
"totalmoh": "00:00:00",
"talkave": "00:00:00",
"talkmax": "00:00:00",
"totaltalk": "00:00:00",
"abanave": "00:00:00",
"abanmax": "00:00:00",
"postave": "00:00:00",
"postmax": "00:00:00",
"postcum": "00:00:00",
"processave": "00:00:00",
"processmax": "00:00:00",
"processcum": "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 レスポンスパラメータ
サマリーレポートのレスポンスパラメータは以下となります。
queue_id | 画面上での該当項目:なし ・取得対象のコールセンターのIDです |
---|---|
queue_name | 画面上での該当項目:コールセンター名 ・取得対象のコールセンターの名称です ※「集計対象プルダウン」でコールセンターを選択時に表示される項目です |
sip_user_name | 画面上での該当項目:内線番号 ・取得対象のコールセンターの内線番号(例 7000)です ※「集計対象プルダウン」でコールセンターを選択時に表示される項目です |
business_id | 画面上での該当項目:なし ・取得対象の業務ラベルのIDです |
business_name | 画面上での該当項目:業務ラベル名 ・取得対象の業務ラベルの名称です ※「集計対象プルダウン」で業務ラベルを選択時に表示される項目です |
ent | 画面上での該当項目:着信数 ・コールセンターに着信した呼数です ・着信イベントが発生した日時で集計します ※着信イベントは初期ガイダンスが終了した時点で発生します。 ※初期ガイダンス再生中はコールセンターへの着信件数に含まれません。 |
con | 画面上での該当項目:応答数 ・エージェントがお客様と通話を開始した呼数です ・応答イベントが発生した日時で集計します |
moh | 画面上での該当項目:保留数・合計 ・エージェントが通話を保留した呼数です ・保留を解除した日時で集計します |
mohshort | 画面上での該当項目:保留数・目標値超 ・エージェントが通話を保留した呼の内、設定した目標値を超えた保留の回数です ・保留を解除した日時で集計します |
aban | 画面上での該当項目:放棄数・合計 ・キューイング(お待たせ)中にエージェントと通話を行わずに発信元が切断した呼数です ・放棄呼イベントが発生した日時で集計します |
abanshort | 画面上での該当項目:放棄数・指定秒数内 ・キューイング(お待たせ)中にエージェントと通話を行わずに発信元が切断した呼の内、ショートアバンダン設定時間内で切断された呼数です ・放棄呼イベントが発生した日時で集計します |
dump | 画面での該当項目:なし ・エージェントがエージェント向けガイダンス中に切断した回数です |
comp | 画面上での該当項目:通話・通話終了数 ・エージェントがお客様との通話を終了した呼数です ・通話終了イベントが発生した日時で集計します |
tmout | 画面上での該当項目:タイムアウト ・各コールセンターで、着信設定タブの不在着信を有効にしていた場合、不在判定(秒)で設定した時間を経過し、不在着信の動作が起動した呼数です ・タイムアウトイベントが発生した日時で集計します |
waitcall |
画面上での該当項目:2番目以降キューイング数 |
outou | 画面上での該当項目: 応答率 ・応答数 ÷ 着信数 の値です ※小数第3位を四捨五入した値として%で集計します |
svclevcnt | 画面上での該当項目:サービスレベル・サービスレベル応答数 ・詳細設定のサービスレベル目標時間で設定した秒数内での応答呼数です ・応答イベントが発生した日時で集計します |
svclev | 画面上での該当項目:サービスレベル・サービスレベル(%) ・サービスレベル応答数 / 着信数 の値 ※小数点第3位を四捨五入した値として%で集計します |
conave | 画面上での該当項目:応答時間・平均 ・着信してからエージェントが応答するまでの待ち時間の平均時間です ・応答イベントが発生した日時で集計します ※小数点以下は切り捨てて表示します |
mohave | 画面上での該当項目:保留時間・平均 ・エージェントが通話を保留して通話に戻るまでの平均時間です ・保留を解除した日時で集計します ※小数点以下は切り捨てて表示します |
conmax | 画面上での該当項目:応答時間・最大 ・着信してからエージェントが応答するまでの、待ち時間の最大時間です ・応答イベントが発生した日時で集計します |
mohmax | 画面上での該当項目:保留時間・最大 ・エージェントが通話を保留して通話に戻るまでの最大時間です ・保留を解除した日時で集計します |
totalmoh | 画面上での該当項目:保留時間・累計 ・エージェントが通話を保留して通話に戻るまでの累計時間です ・保留を解除した日時で集計します |
talkave | 画面上での該当項目:通話・平均 ・エージェントの平均通話時間です ・通話終了イベントが発生した日時で集計小数点以下は切り捨てて表示します |
talkmax | 画面上での該当項目:通話・最大 ・エージェントの最大通話時間です ・通話終了イベントが発生した日時で集計します |
totaltalk | 画面上での該当項目:通話・累計 ・エージェントの総通話時間です ・通話終了イベントが発生した日時で集計します |
abanave | 画面上での該当項目:放棄時間・平均 ・着信してから放棄呼になるまでの、平均時間です ・放棄呼イベントが発生した日時で集計します ※小数点以下は切り捨てて表示します |
abanmax | 画面上での該当項目:放棄時間・最大 ・着信してから放棄呼になるまでの、最大時間です ・放棄呼イベントが発生した日時で集計します |
postave | 画面上での該当項目:後作業時間(CC紐づけあり)・平均 対象コールセンターに所属する全エージェントの後作業ステータスになってから別ステータスに変更されるまでの経過時間の平均です |
postmax | 画面上での該当項目:後作業時間(CC紐づけあり)・最大 対象コールセンターに所属する全エージェントの後作業ステータスになってから別ステータスに変更されるまでの経過時間の最大です |
postcum | 画面上での該当項目:後作業時間(CC紐づけあり)・累計 対象コールセンターに所属する全エージェントの後作業ステータスになってから別ステータスに変更されるまでの経過時間の累計です |
processave | 画面上での該当項目:処理時間・平均 ・対象コールセンターに所属する全エージェントの通話時間+後作業時間の平均です ・通話時間は、通話終了イベントが発生した日時で集計します ・後作業時間は、後作業ステータスから別ステータスに変更された日時で集計します |
processmax | 画面上での該当項目:処理時間・最大 ・対象コールセンターに所属する全エージェントの通話時間+後作業時間の最大です ・通話時間は、通話終了イベントが発生した日時で集計します ・後作業時間は、後作業ステータスから別ステータスに変更された日時で集計します |
processcum | 画面上での該当項目:処理時間・累計 ・対象コールセンターに所属する全エージェントの通話時間+後作業時間の累計です ・通話時間は、通話終了イベントが発生した日時で集計します ・後作業時間は、後作業ステータスから別ステータスに変更された日時で集計します |
2.8 エラー仕様
パラメータ | エラー条件 | name | type | message |
---|---|---|---|---|
from | 開始日時より前の終了日時を設定する | ValidateException | VALIDATE_ERROR | greater than to |
開始日時から終了日時までの範囲が2年より広い状態 | 集計期間は2年(730日)以内で指定してください | |||
to | 開始日時より前の終了日時を設定する | ValidateException | VALIDATE_ERROR | greater than to |
開始日時から終了日時までの範囲が2年より広い状態 | 集計期間は2年(730日)以内で指定してください | |||
category | 半角数字以外を入力した場合 | ValidateException | VALIDATE_ERROR | 引数が数値でありません: '{入力文字列}' |
「0:コールセンター」「1:業務ラベル」以外を入力した場合 | 0〜1までにしてください | |||
queue_ids | 未入力 (集計対象未入力または集計対象プルダウンでコールセンターを選択時) |
ValidateException | VALIDATE_ERROR | report_queue_i_ds:値がありません |
半角数字以外を入力した場合 (集計対象未入力または集計対象プルダウンでコールセンターを選択時) |
引数が数値でありません: '{入力文字列}' | |||
コールセンター一覧に存在しないコールセンターIDを入力した場合 (集計対象未入力または集計対象プルダウンでコールセンターを選択時) |
EntityNotFoundException | NOT_FOUND | 対象が存在しません | |
business_ids | 未入力 (集計対象未入力または集計対象プルダウンで業務ラベルを選択時) |
ValidateException | VALIDATE_ERROR | report_business_i_ds:値がありません |
半角数字以外を入力した場合 (集計対象未入力または集計対象プルダウンで業務ラベルを選択時) |
引数が数値でありません: '{入力文字列}' | |||
業務ラベル一覧に存在しない業務ラベルIDを入力した場合 (集計対象未入力または集計対象プルダウンで業務ラベルを選択時) |
EntityNotFoundException | NOT_FOUND | 対象が存在しません | |
servicelevel | 半角数字以外を入力した場合 | ValidateException | VALIDATE_ERROR | 引数が数値でありません: '{入力文字列}' |
「1〜300」以外を入力した場合 | 1〜300までにしてください | |||
abanshorttime | 半角数字以外を入力した場合 | ValidateException | VALIDATE_ERROR | 引数が数値でありません: '{入力文字列}' |
「1〜300」以外を入力した場合 | 1〜300までにしてください | |||
mohshorttime | 半角数字以外を入力した場合 | ValidateException | VALIDATE_ERROR | 引数が数値でありません: '{入力文字列}' |
「1〜300」以外を入力した場合 | 1〜300までにしてください | |||
Authorization | トークンが未入力の場合(Tokenの入力もされていない) | AuthenticationException | UNAUTHENTICATED | Unauthenticated: cause=unknown auth method. |
認証に失敗した場合 ※「Token」のみ入力した場合 |
Unauthenticated: method=personal_token, cause=invalid request | |||
認証に失敗した場合 ※「Token {誤ったToken文字列}」のみ入力した場合 |
Unauthenticated: method=personal_token, cause=invalid token. | |||
ライセンス無効 | Unauthenticated: method=personal_token, cause=api license disabled | |||
-- | レポート取得APIライセンスがOFFの状態で通話・ステータスレポート情報取得APIを実行した場合 | AuthorizationException | FORBIDDEN | This action is unauthorized. |
「バーストの単位秒数」に設定した秒数以内に、「バースト時の上限値」を超過するリクエストがあった場合 | AccessLimitException | REQUEST_BURST_LIMIT_EXCEEDED | サーバへの処理リクエストが集中しています。しばらく待ってから操作を再試行してください。 |
3.日時・曜日別レポートの取得
3.1 API仕様
URI schemeは以下となります。
Host | sXXXXXXXXXXXX.u.biztel.jp:8000 | BIZTELサーバアドレスとして指定されたFQDN |
---|---|---|
scheme | HTTPS | - |
3.2 リクエスト方式
日時・曜日別レポートのデータを取得時のリクエスト方式は以下となります。
認証方式 | HTTPメソッド | URI | 備考 |
---|---|---|---|
APIトークン認証方式 | GET | /public/api/v1/report/queue/datewise |
APIトークンによるアカウント認証が必要です。 |
3.3 リクエストパラメータ
日時・曜日別レポートの取得で使用するパラメータはサマリーレポートの「2.3 リクエストパラメータ」に加え、以下のパラメータが利用可能です。
パラメータ | 説明 | 備考 | 必須項目 | パラメータ型 | データ型 | 初期値 |
---|---|---|---|---|---|---|
grouptype | 集計単位を選択します |
画面での該当項目:集計単位 1:月、2:日、3:時間、4:分、5:曜日 |
No | query | integer | 3 |
● 実行形式
macOSのターミナルにて、curlコマンド実行する場合の例
curl -X GET --header "Accept: application/json" --header "Authorization: Token ★払い出しトークン★" "https://★契約BIZTELサーバFQDN★:8000/public/api/v1/report/queue/datewise?★リクエストパラメータ★"
● 入力サンプル
curl -X GET --header "Accept: application/json" --header "Authorization: Token d6357156532a940baea9e0012bab1e55e9e4cb51e6c9a352e16206d053303929c9e52cd4609a4bbf" "https://sxxxxxxxxxxxx.u.biztel.jp:8000/public/api/v1/report/queue/datewise?&queue_ids=10001&category=0&servicelevel=30&abanshorttime=30&mohshorttime=30&grouptype=3"
3.4 レスポンスコード
日時・曜日別レポートのレスポンスコードはサマリーレポートの「2.4 レスポンスコード」と同様です。
3.5 ヘッダー
日時・曜日別レポートのヘッダー情報はサマリーレポートの「2.5 ヘッダー」と同様です。
3.6 レスポンスボディ
日時・曜日別レポートのレスポンスボディは以下となります。
● 取得に成功した場合の例
{
"ent": "0",
"con": "0",
"moh": "0",
"mohshort": "0",
"aban": "0",
"abanshort": "0",
"dump": "0",
"comp": "0",
"tmout": "0",
"waitcall": "0",
"outou": "0.0000",
"svclevcnt": "0",
"svclev": "0.0000",
"conave": "00:00:00",
"mohave": "00:00:00",
"conmax": "00:00:00",
"mohmax": "00:00:00",
"totalmoh": "00:00:00",
"talkave": "00:00:00",
"talkmax": "00:00:00",
"totaltalk": "00:00:00",
"abanave": "00:00:00",
"abanmax": "00:00:00",
"postave": "00:00:00",
"postmax": "00:00:00",,
"postcum": "00:00:00",
"processave": "00:00:00",
"processmax": "00:00:00",
"processcum": "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 レスポンスパラメータ
日時・曜日別レポートのレスポンスパラメータは以下となります。
ent | 画面上での該当項目:着信数 ・コールセンターに接続した呼数です ・着信イベントが発生した日時で集計します ※着信イベントは初期ガイダンスが終了した時点で発生します。 ※初期ガイダンス再生中はコールセンターへの着信件数に含まれません。 |
---|---|
con | 画面上での該当項目:応答数 ・エージェントがお客様と通話を開始した呼数です ・応答イベントが発生した日時で集計します |
moh | 画面上での該当項目:保留数・合計 ・エージェントが通話を保留した呼数です ・保留を解除した日時で集計します |
mohshort | 画面上での該当項目:保留数・目標値超 ・エージェントが通話を保留した呼の内、設定した目標値を超えた保留の回数です ・保留を解除した日時で集計します |
aban | 画面上での該当項目:放棄数・合計 ・キューイング(お待たせ)中にエージェントと通話を行わずに発信元が切断した呼数です ・放棄呼イベントが発生した日時で集計します |
abanshort | 画面上での該当項目:放棄数・指定秒数内 ・キューイング(お待たせ)中にエージェントと通話を行わずに発信元が切断した呼の内、ショートアバンダン設定時間内で切断された呼数です ・放棄呼イベントが発生した日時で集計します |
dump | 画面での該当項目:なし エージェントがエージェント向けガイダンス中に通話を切断した回数です |
comp | 画面上での該当項目:通話・通話終了数 ・エージェントがお客様との通話を終了した呼数です ・通話終了イベントが発生した日時で集計します |
tmout | 画面上での該当項目:タイムアウト ・各コールセンターで、着信設定タブの不在着信を有効にしていた場合、不在判定(秒)で設定した時間を経過し、不在着信の動作が起動した呼数です ・タイムアウトイベントが発生した日時で集計します |
waitcall | 画面上での該当項目:2番目以降キューイング数 ・着信時に待ち順番が 2番目以降であった呼数です ・待ち呼の発生時刻ではなく、応答の場合は通話終了時刻、放棄呼の場合は放棄時刻を参照して集計します ※待ち呼の状態からエージェントが応答した状態、または応答前に発信者による切断のパターンが集計されます。 |
outou | 画面上での該当項目: 応答率 ・応答数 ÷ 着信数 の値です ※小数第 3 位を四捨五入した値として%で表示します |
svclevcnt | 画面上での該当項目:サービスレベル・サービスレベル応答数 ・詳細設定のサービスレベル目標時間で設定した秒数内での応答呼数です ・応答イベントが発生した日時で集計します |
svclev |
画面上での該当項目:サービスレベル・サービスレベル(%) |
conave | 画面上での該当項目:応答時間・平均 ・着信してからエージェントが応答するまでの待ち時間の平均時間です ・応答イベントが発生した日時で集計します ※小数点以下は切り捨てて表示します |
mohave | 画面上での該当項目:保留時間・平均 ・エージェントが通話を保留して通話に戻るまでの平均時間です ・保留を解除した日時で集計します ※小数点以下は切り捨てて表示します |
conmax | 画面上での該当項目:応答時間・最大 ・着信してからエージェントが応答するまでの、待ち時間の最大時間です ・応答イベントが発生した日時で集計します |
mohmax | 画面上での該当項目:保留時間・最大 ・エージェントが通話を保留して通話に戻るまでの最大時間です ・保留を解除した日時で集計すます |
totalmoh | 画面上での該当項目:保留時間・累計 ・エージェントが通話を保留して通話に戻るまでの累計時間です ・保留を解除した日時で集計します |
talkave | 画面上での該当項目:通話・平均 ・エージェントの平均通話時間です ・通話終了イベントが発生した日時で集計します ※小数点以下は切り捨てて表示します |
talkmax | 画面上での該当項目:通話・最大 ・エージェントの最大通話時間です ・通話終了イベントが発生した日時で集計します |
totaltalk | 画面上での該当項目:通話・累計 ・エージェントの総通話時間です ・通話終了イベントが発生した日時で集計します |
abanave | 画面上での該当項目:放棄時間・平均 ・着信してから放棄呼になるまでの、平均時間です ・放棄呼イベントが発生した日時で集計します ※小数点以下は切り捨して表示する |
abanmax | 画面上での該当項目:放棄時間・最大 ・着信してから放棄呼になるまでの、最大時間です ・放棄呼イベントが発生した日時で集計します |
postave | 画面上での該当項目:後作業時間(CC紐づけあり)・平均 ・対象コールセンターに所属する全エージェントの後作業ステータスになってから別ステータスに変更されるまでの経過時間の平均値です |
postmax | 画面上での該当項目:後作業時間(CC紐づけあり)・最大 ・対象コールセンターに所属する全エージェントの、後作業ステータスになってから別ステータスに変更されるまでの経過時間の最大値です |
postcum | 画面上での該当項目:後作業時間(CC紐づけあり)・累計 対象コールセンターに所属する全エージェントの後作業ステータスになってから別ステータスに変更されるまでの経過時間の累計です |
processave | 画面上での該当項目:処理時間・平均 対象コールセンターに所属する全エージェントの通話時間+後作業時間の平均です ・通話時間は、通話終了イベントが発生した日時で集計します ・後作業時間は、後作業ステータスから別ステータスに変更された日時で集計します |
processmax | 画面上での該当項目:処理時間・最大 対象コールセンターに所属する全エージェントの通話時間+後作業時間の最大です ・通話時間は、通話終了イベントが発生した日時で集計します ・後作業時間は、後作業ステータスから別ステータスに変更された日時で集計します |
processcum | 画面上での該当項目:処理時間・累計 対象コールセンターに所属する全エージェントの通話時間+後作業時間の累計です ・通話時間は、通話終了イベントが発生した日時で集計します ・後作業時間は、後作業ステータスから別ステータスに変更された日時で集計します |
time | 画面上での該当項目:日時/曜日 ・集計単位で月・日・時間・時間(10 分)を選択した場合は日時、曜日を選択した場合は曜日を表示します |
3.8 エラー仕様
パラメータ | エラー条件 | name | type | message |
---|---|---|---|---|
from | 開始日時より前の終了日時を設定する | ValidateException | VALIDATE_ERROR | greater than to |
開始日時から終了日時までの範囲が2年より広い状態場合 | 集計期間は2年(730日)以内で指定してください | |||
to | 開始日時より前の終了日時を設定する | ValidateException | VALIDATE_ERROR | greater than to |
開始日時から終了日時までの範囲が2年より広い状態場合 | 集計期間は2年(730日)以内で指定してください | |||
category | 半角数字以外を入力した場合 | ValidateException | VALIDATE_ERROR | 引数が数値でありません: '{入力文字列}' |
「0:コールセンター」「1:業務ラベル」以外を入力した場合 | 0〜1までにしてください | |||
grouptype | 半角数字以外を入力した場合 | ValidateException | VALIDATE_ERROR | 引数が数値でありません: '{入力文字列}' |
「1:月」「2:日」「3:時」「4:分」「5:曜日」以外を入力した場合 | 1〜5までにしてください | |||
queue_ids | 未入力 (集計対象未入力または集計対象プルダウンで業務ラベルを選択時) |
ValidateException | VALIDATE_ERROR | report_queue_i_ds:値がありません |
半角数字以外を入力した場合 (集計対象未入力または集計対象プルダウンで業務ラベルを選択時) |
引数が数値でありません: '{入力文字列}' | |||
コールセンター一覧に存在しない業務ラベルIDを入力した場合 (集計対象未入力または集計対象プルダウンで業務ラベルを選択時) |
EntityNotFoundException | NOT_FOUND | 対象が存在しません | |
business_ids | 未入力 (集計対象未入力または集計対象プルダウンで業務ラベルを選択時) |
ValidateException | VALIDATE_ERROR | report_business_i_ds:値がありません |
半角数字以外を入力した場合 (集計対象未入力または集計対象プルダウンで業務ラベルを選択時) |
引数が数値でありません: '{入力文字列}' | |||
業務ラベル一覧に存在しない業務ラベルIDを入力した場合 (集計対象未入力または集計対象プルダウンで業務ラベルを選択時) |
EntityNotFoundException | NOT_FOUND | 対象が存在しません | |
servicelevel | 半角数字以外を入力した場合 | ValidateException | VALIDATE_ERROR | 引数が数値でありません: '{入力文字列}' |
「1〜300」以外を入力した場合 | 1〜300までにしてください | |||
abanshorttime | 半角数字以外を入力した場合 | ValidateException | VALIDATE_ERROR | 引数が数値でありません: '{入力文字列}' |
「1〜300」以外を入力した場合 | 1〜300までにしてください | |||
mohshorttime | 半角数字以外を入力した場合 | ValidateException | VALIDATE_ERROR | 引数が数値でありません: '{入力文字列}' |
「1〜300」以外を入力した場合 | 1〜300までにしてください | |||
Authorization | トークンが未入力の場合(Tokenの入力もされていない) | AuthenticationException | UNAUTHENTICATED | Unauthenticated: cause=unknown auth method. |
認証に失敗した場合 ※「Token」のみ入力した場合 |
Unauthenticated: method=personal_token, cause=invalid request | |||
認証に失敗した場合 ※「Token {誤ったToken文字列}」のみ入力した場合 |
Unauthenticated: method=personal_token, cause=invalid token. | |||
ライセンス無効 | Unauthenticated: method=personal_token, cause=api license disabled | |||
-- | レポート取得APIライセンスがOFFの状態で日時・曜日別レポート情報取得APIを実行する | AuthorizationException | FORBIDDEN | This action is unauthorized. |
「バーストの単位秒数」に設定した秒数以内に、「バースト時の上限値」を超過するリクエストがあった場合 | AccessLimitException | REQUEST_BURST_LIMIT_EXCEEDED | サーバへの処理リクエストが集中しています。しばらく待ってから操作を再試行してください。 |
4.応答時間分布レポートの取得
4.1 API仕様
URI schemeは以下となります。
Host | sXXXXXXXXXXXX.u.biztel.jp:8000 | BIZTELサーバアドレスとして指定されたFQDN |
---|---|---|
scheme | HTTPS | - |
4.2 リクエスト方式
応答時間分布レポートのデータを取得時のリクエスト方式は以下となります。
認証方式 | HTTPメソッド | URI | 備考 |
---|---|---|---|
APIトークン認証方式 | GET | /public/api/v1/report/queue/response_time |
APIトークンによるアカウント認証が必要です。 リクエストヘッダにAuthorization: Token (APIトークン)を指定します。 ※アカウント>APIトークンタブから払い出します。詳細は「1.APIトークン」を参照ください。 |
4.3 リクエストパラメータ
パラメータ | 説明 | 備考 | 必須項目 | パラメータ型 | データ型 | 初期値 |
---|---|---|---|---|---|---|
from | 集計開始日時を指定します | 画面での該当項目:集計開始日時 画面での該当項目は必須項目です |
No | query | string |
当日0時 yyyy/mm/dd hh:mm |
to | 集計終了日時を指定します | 画面での該当項目:集計終了日時 画面での該当項目は必須項目です |
No | query | string |
翌日0時 (当日の24時) yyyy/mm/dd hh:mm |
category | 集計対象を選択します | 画面での該当項目:集計対象 0:コールセンター 1:業務ラベル |
No | query | integer | 0 |
queue_ids | コールセンターを選択します | 画面での該当項目:コールセンター 集計対象プルダウンでコールセンターを選択時 |
Yes: 集計対象未入力または集計対象プルダウンでコールセンターを選択時 No: 集計対象プルダウンでコールセンターを選択時 |
query | string | -- |
business_ids | 業務ラベルを選択します | 画面での該当項目:業務ラベル 集計対象プルダウンで業務ラベルを選択時 |
Yes: 集計対象プルダウンで業務ラベルを選択時 No: 集計対象未入力または集計対象プルダウンでコールセンターを選択時 |
query | string | -- |
servicelevel | サービスレベル目標時間 (秒)を選択・入力します | 画面での該当項目:詳細設定・サービスレベル目標時間 (秒) | Yes | query | integer | 30 |
maxtime | 分布グラフの時間軸 (秒)を選択・入力します | 画面での該当項目:詳細設定・分布グラフの時間軸 (秒) | Yes | query | integer | 1200 |
interval | 分布グラフの時間軸・間隔 (秒)を選択します | 画面での該当項目:詳細設定・分布グラフの時間軸・集計間隔 (秒) | Yes | query | integer | 1 |
Authorization |
APIトークン認証方式の場合に用います | ''Tokenトークン文字列'の形式で入力します | Yes | header | string | -- |
● 実行形式
macOSのターミナルにて、curlコマンド実行する場合の例
curl -X GET --header "Accept: application/json" --header "Authorization: Token ★払い出しトークン★" "https://★契約BIZTELサーバFQDN★:8000/public/api/v1/report/queue/response_time?★リクエストパラメータ★"
● 入力サンプル
curl -X GET --header "Accept: application/json" --header "Authorization: Token d6357156532a940baea9e0012bab1e55e9e4cb51e6c9a352e16206d053303929c9e52cd4609a4bbf" "https://sxxxxxxxxxxxx.u.biztel.jp:8000/public/api/v1/report/queue/response_time?&queue_ids=10001&category=0&servicelevel=30&maxtime=1200&interval=1"
4.4 レスポンスコード
応答時間分布レポートのレスポンスコードはサマリーレポートの「2.4 レスポンスコード」と同様です。
4.5 ヘッダー
応答時間分布レポートのヘッダー情報はサマリーレポートの「2.5 ヘッダー」と同様です。
4.6 レスポンスボディ
応答時間分布レポートのレスポンスボディは以下となります。
● 取得に成功した場合の例
{
time: "0",
count: "0",
sum: "0",
share: "0",
accumulation: "0"
}
● 取得に失敗した場合の例
{
"name": "AuthenticationException",
"type": "UNAUTHENTICATED",
"exception_id": null,
"message": "Unauthenticated: cause=unknown auth method.",
"messages": null,
"reason": "Unauthenticated: cause=unknown auth method."
}
4.7 レスポンスパラメータ
time | 画面上での該当項目:経過秒数 コールセンターに接続した日時からの経過秒数です |
---|---|
count | 画面での該当項目:応答呼数 各経過秒数に該当するエージェントがお客様と通話を開始した呼数です |
sum | 画面での該当項目:応答呼数(累積) 応答呼数を経過秒数まで累積した呼数です |
share | 画面での該当項目:比率(%) ・経過秒数に該当する 応答数 ÷ 全体の応答数の値です ※小数点第3 位を四捨五入した値として%で表示します |
accumulation | 画面での該当項目:応答比率(%)(累積) ・応答数(累積)÷ 全体の応答数の値です ※小数点第3 位を四捨五入した値として%で出力する |
4.8 エラー仕様
パラメータ | エラー条件 | name | type | message |
---|---|---|---|---|
from | 開始日時より前の終了日時を設定する | ValidateException | VALIDATE_ERROR | greater than to |
開始日時から終了日時までの範囲が2年より広い状態場合 | 集計期間は2年(730日)以内で指定してください | |||
to | 開始日時より前の終了日時を設定する | ValidateException | VALIDATE_ERROR | greater than to |
開始日時から終了日時までの範囲が2年より広い状態場合 | 集計期間は2年(730日)以内で指定してください | |||
category | 半角数字以外を入力した場合 | ValidateException | VALIDATE_ERROR | 引数が数値でありません: '{入力文字列}' |
「0:コールセンター」「1:業務ラベル」以外を入力した場合 | 0〜1までにしてください | |||
queue_ids | 未入力 (集計対象未入力または集計対象プルダウンでコールセンターを選択時) |
ValidateException | VALIDATE_ERROR | report_queue_i_ds:値がありません |
半角数字以外を入力した場合 (集計対象未入力または集計対象プルダウンでコールセンターを選択時) |
引数が数値でありません: '{入力文字列}' | |||
コールセンター一覧に存在しないコールセンターIDを入力した場合 (集計対象未入力または集計対象プルダウンでコールセンターを選択時) |
EntityNotFoundException | NOT_FOUND | 対象が存在しません | |
business_ids | 未入力 (集計対象未入力または集計対象プルダウンで業務ラベルを選択時) |
ValidateException | VALIDATE_ERROR | report_business_i_ds:値がありません |
半角数字以外を入力した場合 (集計対象未入力または集計対象プルダウンで業務ラベルを選択時) |
引数が数値でありません: '{入力文字列}' | |||
業務ラベル一覧に存在しない業務ラベルIDを入力した場合 (集計対象未入力または集計対象プルダウンで業務ラベルを選択時) |
EntityNotFoundException | NOT_FOUND | 対象が存在しません | |
servicelevel | 半角数字以外を入力した場合 | ValidateException | VALIDATE_ERROR | 引数が数値でありません: '{入力文字列}' |
「1〜300」以外を入力した場合 | 1〜300までにしてください | |||
interval | 半角数字以外を入力した場合 | ValidateException | VALIDATE_ERROR | 引数が数値でありません: '{入力文字列}' |
「1〜10」以外を入力した場合 | 1〜10までにしてください | |||
maxtime | 半角数字以外を入力した場合 | ValidateException | VALIDATE_ERROR | 引数が数値でありません: '{入力文字列}' |
Authorization | トークンが未入力の場合(Tokenの入力もされていない) | AuthenticationException | UNAUTHENTICATED | Unauthenticated: cause=unknown auth method. |
認証に失敗した場合 ※「Token」のみ入力した場合 |
Unauthenticated: method=personal_token, cause=invalid request | |||
認証に失敗した場合 ※「Token {誤ったToken文字列}」のみ入力した場合 |
Unauthenticated: method=personal_token, cause=invalid token. | |||
ライセンス無効 | Unauthenticated: method=personal_token, cause=api license disabled | |||
-- | レポート取得APIライセンスがOFFの状態で日時・曜日別レポート情報取得APIを実行する | AuthorizationException | FORBIDDEN | This action is unauthorized. |
「バーストの単位秒数」に設定した秒数以内に、「バースト時の上限値」を超過するリクエストがあった場合 | AccessLimitException | REQUEST_BURST_LIMIT_EXCEEDED | サーバへの処理リクエストが集中しています。しばらく待ってから操作を再試行してください。 |
5.放棄時間分布レポートの取得
5.1 API仕様
URI schemeは以下となります。
Host | sXXXXXXXXXXXX.u.biztel.jp:8000 | BIZTELサーバアドレスとして指定されたFQDN |
---|---|---|
scheme | HTTPS | - |
5.2 リクエスト方式
放棄時間分布レポートのデータを取得時のリクエスト方式は以下となります。
認証方式 | HTTPメソッド | URI | 備考 |
---|---|---|---|
APIトークン認証方式 | GET | /public/api/v1/report/queue/abandon_time |
APIトークンによるアカウント認証が必要です。 |
5.3 リクエストパラメータ
放棄時間分布レポートのリクエストパラメータは応答時間分布レポートの「4.3 リクエストパラメータ」と同様です。
● 実行形式
macOSのターミナルにて、curlコマンド実行する場合の例
curl -X GET --header "Accept: application/json" --header "Authorization: Token ★払い出しトークン★" "https://★契約BIZTELサーバFQDN★:8000/public/api/v1/report/queue/abandon_time?★リクエストパラメータ★"
● 入力サンプル
curl -X GET --header "Accept: application/json" --header "Authorization: Token d6357156532a940baea9e0012bab1e55e9e4cb51e6c9a352e16206d053303929c9e52cd4609a4bbf" "https://sxxxxxxxxxxxx.u.biztel.jp:8000/public/api/v1/report/queue/abandon_time?&queue_ids=10001&category=0&servicelevel=30&maxtime=1200&interval=1"
5.4 レスポンスコード
放棄時間分布レポートのレスポンスコードはサマリーレポートの「2.4 レスポンスコード」と同様です。
5.5 ヘッダー
放棄時間分布レポートのヘッダー情報はサマリーレポートの「2.5 ヘッダー」と同様です。
5.6 レスポンスボディ
放棄時間分布レポートのレスポンスボディは応答時間分布レポートの「4.6 レスポンスボディ」と同様です。
5.7 レスポンスパラメータ
time | 画面上での該当項目:経過秒数 コールセンターに接続した日時からの経過秒数です |
---|---|
count | 画面での該当項目:放棄呼数 放棄呼数を経過秒数まで累積した呼数です |
sum | 画面での該当項目:放棄呼数(累積) 応答呼数を経過秒数まで累積した呼数です |
share | 画面での該当項目:比率(%) ・経過秒数に該当する放棄呼数 ÷ 全体の放棄呼数の値です ※小数点第3位を四捨五入した値として%で表示します |
accumulation | 画面での該当項目:放棄比率(%)(累積) ・放棄呼数(累積)÷ 全体の放棄呼数の値です ※小数点第3位を四捨五入した値として%で表示します |
5.8 エラー仕様
放棄時間分布レポートのエラー仕様は応答時間分布レポートの「4.8 エラー仕様」と同様です。
6.保留時間分布レポートの取得
6.1 API仕様
URI schemeは以下となります。
Host | sXXXXXXXXXXXX.u.biztel.jp:8000 | BIZTELサーバアドレスとして指定されたFQDN |
---|---|---|
scheme | HTTPS | - |
6.2 リクエスト方式
保留時間分布レポートのデータを取得時のリクエスト方式は以下となります。
認証方式 | HTTPメソッド | URI | 備考 |
---|---|---|---|
APIトークン認証方式 | GET | /public/api/v1/report/queue/hold_time |
APIトークンによるアカウント認証が必要です。 |
6.3 リクエストパラメータ
保留時間分布レポートのリクエストパラメータは応答時間分布レポートの「4.3 リクエストパラメータ」と同様です。
● 実行形式
macOSのターミナルにて、curlコマンド実行する場合の例
curl -X GET --header "Accept: application/json" --header "Authorization: Token ★払い出しトークン★" "https://★契約BIZTELサーバFQDN★:8000/public/api/v1/report/queue/hold_time?★リクエストパラメータ★"
● 入力サンプル
curl -X GET --header "Accept: application/json" --header "Authorization: Token d6357156532a940baea9e0012bab1e55e9e4cb51e6c9a352e16206d053303929c9e52cd4609a4bbf" "https://sxxxxxxxxxxxx.u.biztel.jp:8000/public/api/v1/report/queue/hold_time?&queue_ids=10001&category=0&servicelevel=30&maxtime=1200&interval=1"
6.4 レスポンスコード
保留時間分布レポートのレスポンスコードはサマリーレポートの「2.4 レスポンスコード」と同様です。
6.5 ヘッダー
保留時間分布レポートのヘッダー情報はサマリーレポートの「2.5 ヘッダー」と同様です。
6.6 レスポンスボディ
保留時間分布レポートのレスポンスボディは応答時間分布の「4.6 レスポンスボディ」と同様です。
6.7 レスポンスパラメータ
time | 画面上での該当項目:経過秒数 エージェントが接続した時間からの経過秒数です |
---|---|
count | 画面での該当項目:保留呼数 各経過秒数に該当するエージェントが通話を保留して通話に戻るまでの保留数です |
sum | 画面での該当項目:保留呼数(累積) 保留数を経過秒数まで累積した保留数です |
share | 画面での該当項目:比率(%) ・経過秒数に該当する 保留数÷全体の保留数の値です ※小数点第3位を四捨五入した値として%で表示します |
accumulation | 画面での該当項目:保留比率(%)(累積) ・保留数(累積) ÷ 全体の保留数の値です ※小数第3位を四捨五入した値として%で表示します |
6.8 エラー仕様
保留時間分布レポートのエラー仕様は応答時間分布レポートの「4.8 エラー仕様」と同様です。
7.後作業時間分布(CC紐づきあり)レポートの取得
7.1 API仕様
URI schemeは以下となります。
Host | sXXXXXXXXXXXX.u.biztel.jp:8000 | BIZTELサーバアドレスとして指定されたFQDN |
---|---|---|
scheme | HTTPS | - |
7.2 リクエスト方式
後作業時間分布(CC紐づけあり)レポートのデータを取得時のリクエスト方式は以下となります。
認証方式 | HTTPメソッド | URI | 備考 |
---|---|---|---|
APIトークン認証方式 | GET | /public/api/v1/report/queue/post_work_time |
APIトークンによるアカウント認証が必要です。 |
7.3 リクエストパラメータ
後作業時間分布(CC紐づけあり)レポートのリクエストパラメータは応答時間分布レポートの「4.3 リクエストパラメータ」と同様です。
● 実行形式
macOSのターミナルにて、curlコマンド実行する場合の例
curl -X GET --header "Accept: application/json" --header "Authorization: Token ★払い出しトークン★" "https://★契約BIZTELサーバFQDN★:8000/public/api/v1/report/queue/post_work_time?★リクエストパラメータ★"
● 入力サンプル
curl -X GET --header "Accept: application/json" --header "Authorization: Token d6357156532a940baea9e0012bab1e55e9e4cb51e6c9a352e16206d053303929c9e52cd4609a4bbf" "https://sxxxxxxxxxxxx.u.biztel.jp:8000/public/api/v1/report/queue/summary?&queue_ids=10001&category=0&servicelevel=30&abanshorttime=30&mohshorttime=30"
7.4 レスポンスコード
後作業時間分布(CC紐づけあり)レポートのレスポンスコードはサマリーレポートの「2.4 レスポンスコード」と同様です。
7.5 ヘッダー
後作業時間分布(CC紐づけあり)レポートのヘッダー情報はサマリーレポートの「2.5 ヘッダー」と同様です。
7.6 レスポンスボディ
後作業時間分布(CC紐づけあり)レポートのレスポンスボディは応答時間分布の「4.6 レスポンスボディ」と同様です。
7.7 レスポンスパラメータ
time | 画面上での該当項目:経過秒数 エージェントが後作業ステータスになった時間からの経過秒数です |
---|---|
count | 画面での該当項目:後作業数 各経過秒数に該当するエージェントが後作業ステータスから別ステータスに変更された数です |
sum | 画面での該当項目:後作業数(累積) 後作業数を経過秒数まで累積した後作業数です |
share | 画面での該当項目:比率(%) ・経過秒数に該当する 後作業数÷全体の後作業数の値です ※小数点第3位を四捨五入した値として%で表示します |
accumulation | 画面での該当項目:後作業比率(%)(累積) ・後作業数(累積) ÷全体の後作業数の値です ※小数点第3位を四捨五入した値として%で表示します |
7.8 エラー仕様
後作業時間分布(CC紐づきあり)レポートのエラー仕様は応答時間分布レポートの「4.8 エラー仕様」と同様です。
8.APIリクエスト数の消費仕様について
BIZTEL API(レポート取得API)のライセンス消費数は以下となります。
認証方式 | ライセンス消費数 | 備考 |
---|---|---|
APIトークン認証方式 | 1リクエストにつき、1消費 |
累積APIリクエスト数、累積APIレスポンスオブジェクト数ともに1ずつ消費します。 |