VoiceとVideo関連メトリクスのリファレンス
このリファレンスには、VoiceとVideoコール（インバウンドとアウトバウンド）に関するメトリクスがすべて網羅されています。これらのメトリクスは、VoiceとVideoにのみ適用されます。特定のチャネルに対応していないメトリクスについては、メトリクスAPIがリテラル文字列 N/Aを値として返します。
含まれるもの： 通話量、応答率、失敗数、パフォーマンス関連メトリクス
重要データの正確性と一貫性を確保するため、メトリクスAPIは2025年5月15日以降に集計されたVoiceとVideoデータのみを返します。この日付より前の履歴データは利用できません。
クイックリファレンス
| メトリクス | API構文 | 主な用途 |
|---|---|---|
| Total calls (総通話数) | TOTAL_CALL_COUNT | 合計通話量（インバウンド + アウトバウンド） |
| Total attempted outbound calls (アウトバウンドコール試行総数) | TOTAL_ATTEMPTED_CALL_COUNT | 試行したアウトバウンドコール数 |
| Total seized calls (呼び出し成功総数) | TOTAL_SEIZED_CALL_COUNT | デバイスに到達して呼び出し音が鳴ったコール数 |
| Total answered calls (応答通話総数) | TOTAL_ANSWERED_CALL_COUNT | 応答に成功したコール数 |
| Calls answered by person (有人応答通話数) | ANSWERED_BY_PERSON_CALL_COUNT | 人間が応答したアウトバウンドコール数 |
| Calls answered by voice detection (音声検知応答通話数) | ANSWERED_BY_VOICE_DETECTION_CALL_COUNT | ボイスメールまたは電話機で応答する通話 |
| Calls processed by AMD (AMD処理通話数) | AMD_PROCESSED_CALL_COUNT | 自動機械検知機能によって選別されたコール数 |
| Total received calls (着信通話総数) | TOTAL_RECEIVED_CALL_COUNT | 顧客からのインバウンドコール数 |
| Not answered (応答なし) | NOT_ANSWERED_CALL_COUNT | 未応答のアウトバウンドコール数 |
| Canceled (キャンセル数) | CANCELED_CALL_COUNT | ルーティング前にキャンセルされたコール数 |
| Failed (失敗数) | FAILED_CALL_COUNT | エラーまたは拒否によって失敗したコール数 |
| Busy (話し中) | BUSY_CALL_COUNT | 話し中の信号を受信したコール数 |
| Answer seizure ratio (応答成功率) | ANSWER_SEIZURE_RATIO | 呼び出し音が鳴ったコールのうち、応答があった割合 |
| Answer rate (応答率) | ANSWER_RATE | 試行されたすべてのコールのうち、応答があった割合 |
| Busy rate (話し中率) | BUSY_RATE | 試行されたすべてのコールのうち、話し中だった割合 |
| Call hang-ups (通話終了数) | HUNG_UP_COUNT | 終了したコールの総数 |
| Normal hang-ups (正常な通話終了数) | NORMAL_HUNG_UP_COUNT | やり取りが正常に完了した後にユーザー側から通話を終了させたコール数 |
| Hung up due to error (エラーによる通話終了数) | ERROR_HUNG_UP_COUNT | システムエラーによって終了したコール数 |
| Call duration (通話時間) | TOTAL_CALL_DURATION | 全コール合算の通話時間 |
通話量と配信に関するメトリクス
| メトリクス | API構文 | 定義 | 計算方法 |
|---|---|---|---|
| Total calls (総通話数) | TOTAL_CALL_COUNT | 顧客に発信したアウトバウンドコールと顧客から着信したインバウンドコールの総数 | アウトバウンド + インバウンド |
| Total attempted outbound calls (アウトバウンドコール試行総数) | TOTAL_ATTEMPTED_CALL_COUNT | 企業側から発信されたアウトバウンドコールの試行総数 | 総通話数（アウトバウンド） |
| Total seized calls (呼び出し成功総数) | TOTAL_SEIZED_CALL_COUNT | 応答されたかどうかにかかわらず、受信者のデバイスに到達し、呼び出し音が鳴り始めたアウトバウンドコールの総数 | 応答 + 未応答 + 話し中 + 拒否 |
| Total answered calls (応答通話総数) | TOTAL_ANSWERED_CALL_COUNT | インバウンド（顧客からの発信）とアウトバウンド（企業側からの発信）の両方を含む、正常に応答されたコールの総数 | 総通話数 (StatusReason = DELIVERED_TO_HANDSET) |
| Calls answered by person (有人応答通話数) | ANSWERED_BY_PERSON_CALL_COUNT | 人間が応答したアウトバウンドコール数 | — |
| Calls answered by voice detection (音声検知応答通話数) | ANSWERED_BY_VOICE_DETECTION_CALL_COUNT | ボイスメールや自動サービスなどの音声検出システムによって応答されたアウトバウンドコール数 | — |
| Calls processed by AMD (AMD処理通話数) | AMD_PROCESSED_CALL_COUNT | 自動機械検知（AMD）機能を使って処理されたコール数 | 有人応答 + 音声検知応答 |
インバウンド関連メトリクス
| メトリクス | API構文 | 定義 | 計算方法 |
|---|---|---|---|
| Total received calls (着信通話総数) | TOTAL_RECEIVED_CALL_COUNT | 顧客から受信したコールの総数（インバウンド） | 総通話数（インバウンド） |
失敗関連メトリクス
| メトリクス | API構文 | 定義 | 計算方法 |
|---|---|---|---|
| Not answered (応答なし) | NOT_ANSWERED_CALL_COUNT | 受信者が応答しなかったアウトバウンドコールの総数 | 試行通話数 (StatusReason = NO_ANSWER) |
| Canceled (キャンセル数) | CANCELED_CALL_COUNT | 受信者へのルーティングが開始される前に送信者によってキャンセルされたアウトバウンドコールの総数 | 試行通話数 (StatusReason = CANCELLED) |
| Failed (失敗数) | FAILED_CALL_COUNT | ユーザーまたはオペレーターによる拒否、ユーザーの不在、あるいはその他のシステムまたはネットワークのエラーにより失敗したコールの総数 | 総通話数（ステータスがREJECTED、UNDELIVERABLE または EXPIRED、NO_ANSWER と BUSY を除く） |
| Busy (話し中) | BUSY_CALL_COUNT | 話し中信号が返ってきた、または回線が使用中であったために拒否されたアウトバウンドコールの総数 | 試行通話数 (StatusReason = BUSY) |
パフォーマンス関連メトリクス
| メトリクス | API構文 | 定義 | 計算方法 |
|---|---|---|---|
| Answer seizure ratio (応答成功率) | ANSWER_SEIZURE_RATIO | 呼び出しに成功した（呼び出し音が鳴り始めた）コールの割合 | (応答通話数 / 呼び出し成功数) × 100 |
| Answer rate (応答率) | ANSWER_RATE | 試行されたコールのうち、応答に成功した割合 | (応答通話数 / 試行通話数、拒否された通話数を除く) × 100 |
| Busy rate (話し中率) | BUSY_RATE | 試行されたすべてのコールのうち、話し中信号が返ってきた割合 | (話し中だった通話数 / 試行通話数) × 100 |
| Call hang-ups (通話終了数) | HUNG_UP_COUNT | やり取りが正常に完了した後に終了した、またはシステムエラーが原因で終了したコールまたはセッションの総数 | 通常な通話終了数 + エラーによる通話終了数 |
| Normal hang-ups (正常な通話終了数) | NORMAL_HUNG_UP_COUNT | やり取りが正常に完了した後、ユーザーによって終了されたコールまたはセッションの数 | 応答通話数（エラーなし） |
| Hung up due to error (エラーによる通話終了数) | ERROR_HUNG_UP_COUNT | システムエラーが原因で終了したコールまたはセッションの数 | 応答通話数（エラーあり） |
| Call duration (通話時間) | TOTAL_CALL_DURATION | インバウンドコールとアウトバウンドコールの合算通話時間 | — |
機能
VoiceとVideoのコミュニケーションには、様々な技術が用いられています。これらの通信技術は、コールを特定の方法で発信または着信する際に使用するフィルタリングやグループ化機能に応用されています。
| 機能コード | 説明 |
|---|---|
PHONE | 従来の電話によるコール |
WEBRTC | WebRTCベースのコール |
SIPTRUNK | SIPトランキング |
VIBER_BC | Viber Business Calls |
WHATSAPP_BC | WhatsApp Business Calls |
集計ディメンション
VoiceとVideoでは、メッセージング用のチャネルよりも範囲の狭いディメンションしかサポートされていません。APIを通じて出力する集計結果には、メトリクスの精度を確保するために、CHANNEL_CODEが必ずaggregateByで指定しなくても含まれます。 利用可能なディメンションは以下の通りです：
| グループ | ディメンション |
|---|---|
| 時間 | HOUR、DAY、WEEK_SATURDAY_START、WEEK_SUNDAY_START、WEEK_MONDAY_START、MONTH、QUARTER、YEAR |
| 通話のタイミング | TIME_TO_ANSWER — 時間バケットを使って、コールの試行から応答に至るまでの経過時間に基づく集計結果をグループ化します |
| チャネル | CHANNEL_CODE、CHANNEL_NAME、CAPABILITY、DIRECTION |
| 送信者 | SENDER、SENDER_TYPE |
| 地域とネットワーク | COUNTRY_ID、COUNTRY_NAME、NETWORK_ID、NETWORK_NAME |
| アカウント | ACCOUNT_KEY、APPLICATION_ID、ENTITY_ID、COMMUNICATION |
| ステータスとエラー | STATUS、STATUS_GROUP、ERROR_GROUP、ERROR_CODE |
備考
TRAFFIC_TYPE、CAMPAIGN_REFERENCE、URL、SENDER_DOMAIN、RECIPIENT_DOMAINおよびTIME_TO_ANSWER以外のTIME_TO_*ディメンションはVoiceとVideoでは使用できません。関連ページ
メトリクスAPI
これらのメトリクスを、単一のエンドポイントを通じて、メッセージングやメールに関するデータと併せて、クエリ用プログラムで照会できます。
アナライズダッシュボード
Webインターフェース上で利用可能なフィルターや可視化機能を通じて、これらのメトリクスを確認できます。