Voice and Video のメトリックとフィルタ

メトリックAPIは、Voice and Video通信を分析するためのツールを提供します。インバウンドコールとアウトバウンドコールの両方の配信、エンゲージメント、および失敗のメトリックにわたってパフォーマンスを追跡できます。フィルターを使用してクエリをカスタマイズし、時間、方向、ネットワーク、または通信技術でデータをセグメント化します。

このページを使用して、メトリクス API を通じて (opens in a new tab)利用可能なすべての Voice 固有のメトリクスとフィルターを調べます。

大事な

データの正確性と一貫性を確保するために、API は **2025 年 5 月 15 日以降に集計された Voice and Video データのみを返します。この日付より前の履歴データは利用できません。

メトリック

次のメトリックを使用して、Voice and Video トラフィックの配信、パフォーマンス、および通話結果をモニタリングします。

配達

メトリック名	API 構文	形容
合計通話数	`TOTAL_CALL_COUNT`	顧客に送信されたコール(発信)と顧客から受信したコール(インバウンド)の合計数。
試行された発信コールの合計数	`TOTAL_ATTEMPTED_CALL_COUNT`	ビジネスによって開始された発信コール試行の合計数。
押収された通話の総数	`TOTAL_SEIZED_CALL_COUNT`	通話に応答したかどうかに関係なく、受信者のデバイスに到達し、呼び出し音が鳴り始めた発信通話の合計数。
応答されたコールの合計数	`TOTAL_ANSWERED_CALL_COUNT`	着信コール(顧客が開始)と発信コール(ビジネスが開始)の両方を含む、正常に応答されたコールの合計数。
AMDによって処理された通話	`AMD_PROCESSED_CALL_COUNT`	自動機械検出(AMD)を使用して処理されたコールの数。
担当者が応答した通話	`ANSWERED_BY_PERSON_CALL_COUNT`	人間が応答した発信コールの数。
音声検出で応答された通話	`ANSWERED_BY_VOICE_DETECTION_CALL_COUNT`	ボイスメールや自動サービスなどの音声検出システムによって応答された発信コールの数。

受信

メトリック名	API 構文	形容
総受信コール数	`TOTAL_RECEIVED_CALL_COUNT`	顧客から受信した通話の合計数 (着信)。

配信の失敗

メトリック名	API 構文	形容
未回答	`NOT_ANSWERED_CALL_COUNT`	受信者が応答しなかった発信コールの合計数。
キャンセル	`CANCELED_CALL_COUNT`	受信者へのルーティングが開始される前に送信者によってキャンセルされた発信呼び出しの合計数。
失敗	`FAILED_CALL_COUNT`	ユーザーまたはオペレーターからの拒否、ユーザーが使用不可、またはその他のシステムまたはネットワークエラーが原因で失敗したコールの合計数。
忙しい	`BUSY_CALL_COUNT`	ビジー信号を受信した発信コール、または回線が占有されていたために拒否された発信コールの合計数。

パフォーマンス

メトリック名	API 構文	形容
回答の奪取率	`ANSWER_SEIZURE_RATIO`	正常に応答された押収された通話 (呼び出し音が鳴り始めた通話) の割合。
回答率	`ANSWER_RATE`	正常に応答されたすべての通話試行の割合。
ビジー率	`BUSY_RATE`	ビジー信号を受信したすべての試行されたコールの割合。
電話を切る	`HUNG_UP_COUNT`	対話が成功した後、またはシステムエラーが原因で終了したコールまたはセッションの合計数。
通常のハングアップ	`NORMAL_HUNG_UP_COUNT`	対話が成功した後にユーザーによって終了した通話またはセッションの数。
エラーによりハングアップしました	`ERROR_HUNG_UP_COUNT`	システムエラーが原因で終了したコールまたはセッションの数。
通話時間	`TOTAL_CALL_DURATION`	すべての着信コールと発信コールの合計時間。

集計/ディメンション

ディメンションを使用して Voice and Video 指標をグループ化し、国、方向、送信者、機能など、より効果的に分析します。メトリック API は (opens in a new tab) 、時間間隔、呼び出し結果、ネットワーク情報、およびエラーの種類にわたる柔軟な集計 (aggregateBy を使用) をサポートします。

ディメンション名	形容
`ACCOUNT_KEY`	応答のアカウントキーで結果をグループ化し、対応するアカウントキー値を表示します。
`時`	結果を時間ごとにグループ化し、対応するタイムスタンプ値を表示します。
`日`	結果を日ごとにグループ化し、対応する日の値を表示します。
`WEEK_SATURDAY_START`	土曜日から始まる週ごとに結果をグループ化し、対応するタイムスタンプ値を表示します。
`WEEK_SUNDAY_START`	日曜日から始まる週ごとに結果をグループ化し、対応するタイムスタンプ値を表示します。
`WEEK_MONDAY_START`	月曜日から始まる週ごとに結果をグループ化し、対応するタイムスタンプ値を表示します。
`MONTH` (月)	結果を月ごとにグループ化し、対応する月の値を表示します。
`四半期`	結果を四半期ごとにグループ化し、対応する四半期の値を表示します。
`年`	結果を年ごとにグループ化し、対応する年の値を表示します。
`TIME_TO_ANSWER`	コール応答時間で結果をグループ化し、応答時間の説明を表示します。
`CHANNEL_CODE`	結果をチャネル別にグループ化し、対応するチャネルコード値を表示します。
`CHANNEL_NAME`	結果をチャネル名でグループ化し、対応するチャネル名の値を表示します。
「機能」	結果を機能別にグループ化し、対応する機能コード値を表示します。
「ディレクション」	トラフィックの方向で結果をグループ化し、対応する方向の値 (クライアントに送信されたトラフィックの場合は OUTBOUND、クライアントから受信したトラフィックの場合は INBOUND) を表示します。
「送信者」	結果を送信者別にグループ化し、対応する送信者の値を表示します。
`SENDER_TYPE`	結果を送信者の種類別にグループ化し、対応する送信者の種類の値を表示します。
「コミュニケーション」	結果を通信ごとにグループ化し、対応する通信 ID 値を表示します。
`NETWORK_ID`	結果をネットワーク別にグループ化し、対応するネットワーク ID 値を表示します。
`NETWORK_NAME`	結果をネットワーク別にグループ化し、対応するネットワーク名の値を表示します。
`COUNTRY_ID`	結果を国別にグループ化し、対応する国 ID 値を表示します。
`COUNTRY_NAME`	結果を国別にグループ化し、対応する国名の値を表示します。
`APPLICATION_ID`	結果をアプリケーション別にグループ化し、対応するアプリケーション ID 値を表示します。
`ENTITY_ID`	結果をエンティティ別にグループ化し、対応するエンティティ ID 値を表示します。
`STATUS_GROUP`	結果をステータスグループ別にグループ化し、応答の対応するステータスグループ値を表示します。
「ステータス」	結果をステータス名でグループ化し、応答の対応するステータス値を表示します。
`ERROR_GROUP`	結果をエラーグループ別にグループ化し、応答の対応するエラーグループ値を表示します。
`ERROR_CODE`	結果をエラーコードでグループ化し、応答の対応するエラーコード値を表示します。

フィルター

フィルターを使用して、メトリクスのクエリを絞り込み、特定のデータセットをターゲットにします。

フィルター	API 構文	形容	必須
アカウント	`accountKeys`	accountKeys (opens in a new tab) に基づいて特定のアカウントをターゲットにします。レガシーアカウントには制限が適用されます。	いいえ
サブアカウント	`includeSubaccounts`	包括的な分析のためのサブアカウントのトラフィックデータが含まれています。	いいえ
送信時間範囲	`sentSinces`	特定のメッセージの時間枠が含まれます。	はい
送信時間範囲	`sentUntil`	特定のメッセージの時間枠が含まれます。	はい
エンゲージメントの時間枠	`timeToAnswer`	タイムバケットを使用して、コールが応答されるまでにかかった時間を表します。たとえば、1 秒以内に応答された通話のみをフィルタリングできます。`from`バケットは包括的ですが、`to`バケットは排他的です。	いいえ
ステータスとエラーコード	`statusGroups`	特定の状態またはエラーコードによるフィルタ。可能な [一般的な状態コード]の一覧 (/essentials/api-essentials/response-status-and-error-codes#general-status-codes)。可能な [メッセージステータス]の一覧 (/essentials/api-essentials/response-status-and-error-codes#voice-status-codes)。考えられる [エラーコード]の一覧 (/essentials/api-essentials/response-status-and-error-codes#voice-and-webrtc-error-codes)。	いいえ
	`statuses`
	`errorGroups`
	`errorCodes`
方向	`direction`	方向に基づいてトラフィックを分類し、送信メッセージと受信メッセージを区別します。	いいえ
チャンネル	`channelCode`	通信チャネルに基づいてトラフィックを分類します。	はい
資格	`capabilities`	チャネルコードが`VOICE_VIDEO`の場合にのみ適用されます。通話の開始または受信に使用する基盤となるテクノロジを指定します。使用可能な機能とそのコード: 電話番号: `PHONE` WebRTC: 'WEBRTC SIP トランク: `SIPTRUNK` Viberビジネスコール:`VIBER_BC` WhatsApp Businessコール:`WHATSAPP_BC`	いいえ
Sender (送信者)	`senders`	特定の送信者または送信者の種類に基づいてトラフィックをフィルター処理します。送信者タイプに指定できる値のリスト。	いいえ
送信者の種類	`senderTypes`	特定の送信者または送信者の種類に基づいてトラフィックをフィルター処理します。送信者タイプに指定できる値のリスト。	いいえ
通信 ID	`communicationIds`	通信 ID などの特定の識別子に基づいてトラフィックを分類します。これは、ブロードキャストやMoments(フロー)などのInfobip SaaS(Software as a Service)ソリューションを介して送信されるトラフィックにのみ適用されます。	いいえ
ネットワーク	`networkIds`	ネットワーク ID や国 ID などの特定の識別子に基づいてトラフィックを分類します。	いいえ
Country (国)	`countryIds`	ネットワーク ID や国 ID などの特定の識別子に基づいてトラフィックを分類します。	いいえ
アプリケーション	`applicationId`	`applicationId`や`entityId`などのCPaaSXパラメータを追加することで、コミュニケーション活動のソースと目的に関する貴重な洞察を得ることができ、より正確な分析と意思決定に役立ちます。メトリック API は (opens in a new tab) 、1 つの要求内で複数のアプリケーションとエンティティのペアによるデータのフィルタリングをサポートします。 CPaaSXの概念と機能を使用している場合は、これらのパラメータを使用します。 CPaaSXの詳細については、こちら(/cpaas-x)をご覧ください。	いいえ
エンティティ	`entityId`		いいえ

資格

Voice and Video 通信は、さまざまなテクノロジにまたがることができます。capabilities パラメーターは、従来の電話ネットワークやインターネットベースのサービスなど、通話の開始または受信に使用される特定の方法に基づいてデータをフィルタリングおよびグループ化するのに役立ちます。このパラメータはVOICE_VIDEOチャネルにのみ適用され、この統合チャネルでサポートされるさまざまな通信方法を区別できます。これは、さまざまなテクノロジのパフォーマンスを分析する場合に特に役立ちます。

サポートされている機能については、以下の表を参照してください。

機能コード	形容
「電話」	従来の電話
`WEBRTC`	WebRTC ベースの呼び出し
`SIPTRUNK` (英語)	SIPトランキング
`VIBER_BC`	Viberビジネスコール
`WHATSAPP_BC`	WhatsApp Business 通話

使用可能なメトリックとフィルターを理解する例