メトリックの概要
現在、Azure Communication Services には、すべての Azure Communication Services プリミティブ用のメトリックが用意されています。 Azure メトリックス エクスプローラーでは、メール要求から生成されるメトリック データを使用して、独自のグラフをプロットしたり、メトリック値の異常を調査したり、API トラフィックを把握したりすることができます。
メトリックを確認できる場所
Azure Communication Services のプリミティブにより、API 要求のメトリックが生成されます。 これらのメトリックは、Communication Services リソースの [メトリック] タブで確認できます。 Communication Services リソースのブック タブを使って永続的なダッシュボードを作成することもできます。
測定基準の定義
すべての API 要求のメトリックには、メトリック データをフィルター処理するために使用できる 3 つのディメンションが含まれています。 これらのディメンションは、Count という集計の種類を使用することでまとめて集計できます。また、Azure の標準的な集計時系列 (Sum、Average、Min、Max など) をサポートしています。
サポートされる集計の種類と時系列集計について詳しくは、「Azure メトリックス エクスプローラーの高度な機能」を参照してください。
- 操作 - Azure Communication Services チャット ゲートウェイで呼び出すことができるあらゆる操作またはルート。
- 状態コード - 要求の後に送信される状態コードの応答。
- StatusSubClass - 応答の後に送信される一連の状態コード。
高度なメッセージング API 要求
高度なメッセージング API 要求のメトリックに対して次の操作ができます。
| 操作またはルート | 説明 | シナリオ |
|---|---|---|
| DownloadMedia | メディア ペイロードのダウンロード要求。 | 企業がメディア ペイロードのダウンロードを要求しました。 |
| ListTemplates | テンプレートの一覧表示要求。 | 企業が、特定のチャネルのテンプレートを一覧表示するように要求しました。 |
| ReceiveMessage | 受信したメッセージ。 | ユーザーが企業にメッセージを送信しました。 |
| SendMessage | メッセージ通知の送信要求。 | 企業がユーザーにメッセージを送信することを要求しています。 |
| SendMessageDeliveryStatus | 配信状態が受信されました。 | 企業が、ユーザーへの送信を要求したメッセージに対して応答を受信しました。 |
認証 API 要求
認証 API 要求のメトリックでは、次の操作を利用できます。
| 操作またはルート | 説明 |
|---|---|
| CreateIdentity | 1 人のユーザーを表す ID を作成します。 |
| DeleteIdentity | ID を削除します。 |
| CreateToken | アクセス トークンを作成します。 |
| RevokeToken | 指定された時刻より前に、ID 用に作成されたすべてのアクセス トークンを取り消します。 |
| ExchangeTeamsUserAccessToken | Teams ユーザーの Microsoft Entra アクセス トークンを、有効期限が一致する新しい Communication Identity アクセス トークンと交換します。 |
Call Automation API 要求
Call Automation API 要求のメトリックでは、次の操作を利用できます。
| 操作またはルート | 説明 |
|---|---|
| 通話の作成 | ユーザーへの発信呼び出しを作成します。 |
| 通話の応答 | 着信通話に応答します。 |
| 通話のリダイレクト | 着信通話を別のユーザーにリダイレクトします。 |
| 通話の拒否 | 着信通話を拒否します。 |
| 参加者へ通話の転送 | 1 対 1 の呼び出しを別のユーザーに転送します。 |
| プレイ | 通話の参加者にオーディオを再生します。 |
| PlayPrompt | Recognize アクションの一部として、ユーザーにプロンプトを再生します。 |
| Recognize | 通話参加者からのユーザー入力を認識します。 |
| 参加者の追加 | 通話に参加者を追加します。 |
| 参加者の削除 | 通話から参加者を削除します。 |
| 通話の切断 | コール レッグを切断します。 |
| 通話の終了 | すべての参加者の通話を終了します。 |
| 通話の取得 | 通話に関する詳細を取得します。 |
| 参加者の取得 | 通話参加者の詳細を取得します。 |
| 参加者の取得 | 通話のすべての参加者を取得します。 |
| 通話の削除 | 通話を削除します。 |
| 全てのメディア操作のキャンセル | 通話で進行中またはキューに入ったメディア操作をすべて取り消します。 |
チャット API 要求のメトリック操作
チャット API 要求のメトリックには、次の操作が利用できます。
| 操作またはルート | 説明 |
|---|---|
| GetChatMessage | メッセージ ID を使用してメッセージを取得します。 |
| ListChatMessages | スレッドからチャット メッセージの一覧を取得します。 |
| SendChatMessage | スレッドにチャット メッセージを送信します。 |
| UpdateChatMessage | チャット メッセージを更新します。 |
| DeleteChatMessage | チャット メッセージを削除します。 |
| GetChatThread | チャット スレッドを取得します。 |
| ListChatThreads | ユーザーのチャット スレッドの一覧を取得します。 |
| UpdateChatThread | チャット スレッドのプロパティを更新します。 |
| CreateChatThread | チャット スレッドを作成します。 |
| DeleteChatThread | スレッドを削除します。 |
| GetReadReceipts | スレッドの開封確認メッセージを取得します。 |
| SendReadReceipt | ユーザーに代わって開封確認メッセージ イベントをスレッドに送信します。 |
| SendTypingIndicator | ユーザーに代わって入力イベントをスレッドにポストします。 |
| ListChatThreadParticipants | スレッドのメンバーを取得します。 |
| AddChatThreadParticipants | スレッドにスレッド メンバーを追加します。 既にメンバーが存在する場合は、何も変化しません。 |
| RemoveChatThreadParticipant | スレッドからメンバーを削除します。 |
認識されない操作に対して要求が行われた場合は、「無効なルート」値の応答を受け取ります。
Job Router API 要求
Job Router API 要求のメトリックでは、次の操作が利用できます。
| 操作またはルート | 説明 |
|---|---|
| UpsertClassificationPolicy | 分類ポリシーを作成または更新します。 |
| GetClassificationPolicy | ID で既存の分類ポリシーを取得します。 |
| ListClassificationPolicies | 既存の分類ポリシーを取得します |
| DeleteDistributionPolicy | ID で分類ポリシーを削除します。 |
| UpsertDistributionPolicy | 配布ポリシーを作成または更新します。 |
| GetDistributionPolicy | ID で既存の配布ポリシーを取得します。 |
| ListDistributionPolicies | 既存の配布ポリシーを取得します |
| DeleteDistributionPolicy | ID で配布ポリシーを削除します。 |
| UpsertExceptionPolicy | 例外ポリシーを作成または更新します。 |
| GetExceptionPolicy | ID で既存の例外ポリシーを取得します。 |
| ListExceptionPolicies | 既存の例外ポリシーを取得します |
| DeleteExceptionPolicy | ID で例外ポリシーを削除します。 |
| UpsertQueue | キューを作成または更新します。 |
| GetQueue | ID で既存のキューを取得します。 |
| GetQueues | 既存のキューを取得します |
| DeleteQueue | ID でキューを削除します。 |
| GetQueueStatistics | キューの統計情報を取得します。 |
| UpsertJob | ジョブを作成または更新します。 |
| GetJob | ID で既存のジョブを取得します。 |
| GetJobs | 既存のジョブを取得します |
| DeleteJob | ID でキュー ポリシーを削除します。 |
| ReclassifyJob | ジョブを再分類します。 |
| CancelJob | 自由形式の取り消し理由を指定しながら、ID で既存のジョブを取り消す要求を送信します。 |
| CompleteJob | 割り当てられたジョブを完了します。 |
| CloseJob | 完了したジョブを閉じます。 |
| AcceptJobOffer | ジョブを作業するオファーを受け入れ、別のエージェントが既にジョブを受け入れている場合は 409/Conflict を返します。 |
| DeclineJobOffer | ジョブを作業するオファーを拒否します。 |
| UpsertWorker | worker を作成または更新します。 |
| GetWorker | ID で既存の worker を取得します。 |
| GetWorkers | 既存のworker を取得します。 |
| DeleteWorker | worker とそのすべてのトレースを削除します。 |
Network Traversal API 要求
Network Traversal API 要求のメトリックでは、次の操作を利用できます。
| 操作またはルート | 説明 |
|---|---|
| IssueRelayConfiguration | STUN/TURN サーバーの構成に関する問題 |
Rooms API 要求
Rooms API 要求のメトリックでは、次の操作が利用できます。
| 操作またはルート | 説明 |
|---|---|
| CreateRoom | 会議室を作成します。 |
| DeleteRoom | 会議室を削除します。 |
| GetRoom | 会議室 ID で会議室を取得します。 |
| PatchRoom | 会議室 ID で会議室を更新します。 |
| ListRooms | Azure Communication Services リソースのすべてのルームを一覧表示します。 |
| AddParticipants | 会議室に参加者を追加します。 |
| RemoveParticipants | 会議室から参加者を削除します。 |
| GetParticipants | ルームの参加者の一覧を取得します。 |
| UpdateParticipants | ルームの参加者の一覧を更新します。 |
SMS API 要求
SMS API 要求のメトリックには、次の操作が利用できます。
| 操作またはルート | 説明 |
|---|---|
| SMSMessageSent | SMS メッセージを送信します。 |
| SMSDeliveryReportsReceived | SMS 配信レポートを取得します。 |
| SMSMessagesReceived | SMS メッセージを取得します。 |
次のステップ
- データ プラットフォームのメトリックの詳細をご確認ください。