QM 通話セッション イベント データ

このページでは、コンタクト センター AI プラットフォーム（CCAI プラットフォーム）が品質管理（QM）アプリケーションにエクスポートできる通話セッション イベント データについて説明します。CCAI Platform と QM アプリケーションの統合の詳細については、QM、SIPREC、WFM の統合をご覧ください。

チャット セッションのイベントデータについては、QM チャット セッションのイベントデータをご覧ください。

通話セッションのイベントとトリガー

特定の通話セッション イベントが発生すると、通話セッション データが QM アプリケーションにエクスポートされます。このセクションでは、通話イベントのタイプと、各イベントをトリガーするアクションを一覧表示します。また、各セッション イベント タイプのセッション イベント ペイロードの例も含まれています。

エージェントがログインする

このイベントは、次のアクションによってトリガーされます。

  • エージェントは、コンタクト センター AI プラットフォーム ポータルを使用してエージェント アダプターにログインします。

  • エージェントは CRM を使用してエージェント アダプタにログインします。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "AgentState",
 "item" : {
  "ParticipantID" : "1234",
  "Email" : "some.email@domain.com",
  "State" : "login"
 }
}

エージェントがログアウトする

このイベントは、次のアクションによってトリガーされます。

  • エージェントは、コンタクト センター AI プラットフォーム ポータルを使用してエージェント アダプターからログアウトします。

  • エージェントが CRM を使用してエージェント アダプタからログアウトします。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "AgentState",
 "item" : {
  "ParticipantID" : "1234",
  "Email" : "some.email@domain.com",
  "State" : "logout"
 }
}

着信が投影される

このイベントは、エンドユーザーがコンタクト センターに電話をかけ、その電話がエージェントに転送されたときにトリガーされます。

このイベントは、通話がデルタキャスト用に投影されている場合にのみ適用されます。マルチキャスト プロジェクションではイベントはトリガーされません。カスケード グループ内の通話の最初のデルタキャスト プロジェクションのみがイベントをトリガーします。

このイベントには、通話転送、リダイレクト、転送によって受信した通話予測が含まれます。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "ringing",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
   {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "ringing"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

着信に応答

このイベントは、エージェントが予測通話に応答したときにトリガーされます。

このイベントは、デルタキャストまたはマルチキャスト プロジェクションの両方で、エージェントが通話に応答したときに適用されます。このイベントは、通話転送と通話転換によって受信して応答した通話に適用されます。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "connected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

発信通話が鳴っている

このイベントは、次のアクションによってトリガーされます。

  • エージェントが新しいアウトバウンド コールを発信し、エンドユーザーの電話が鳴っています。

  • エージェントが通話に別の参加者を追加し、その参加者に着信音が鳴っている。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "e9dd62bb",
  "State" : "dialing",
  "Direction" : "outgoing",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "connected"
   },
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

発信通話に応答があった

このイベントは、次のアクションによってトリガーされます。

  • エンドユーザーが発信に応答します。

  • 第三者が参加者追加通話に応答します。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "e9dd62bb",
  "State" : "connected",
  "Direction" : "outgoing",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "connected"
   },
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

通話が保留状態になる

このイベントは、次のアクションによってトリガーされます。

  • エージェントがエンドユーザーを保留にします。

  • エージェントが第三者を保留にする。

次のコードサンプルは、イベント ペイロードを示しています。

 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "held",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "held"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

通話の保留が解除される

このイベントは、次のアクションによってトリガーされます。

  • エージェントがエンドユーザーの保留を解除します。

  • エージェントがサードパーティの保留を解除します。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "connected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

コールド転送が開始され、承認された

このイベントは、次のアクションによってトリガーされます。

  • エージェントが別のエージェントにコールド転送の電話をかけ、転送が受け入れられた。

  • エージェントが別のキューにコールド転送の電話をかけ、そのキューのエージェントが転送を受け入れた場合。

  • エージェントが別のエージェントを電話会議に招待し、別のエージェントが招待を承諾して電話会議に参加します。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "transferred",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "4321",
    "Type" : "agent",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

引き継ぎ後の転送が開始され、承認される

このイベントは、次のアクションによってトリガーされます。

  • エージェントが別のエージェントに引き継ぎ後の転送を行い、転送が受け入れられた。

  • エージェントが別のキューに引き継ぎ後の転送を行い、そのキューのエージェントが転送を受け付けた場合。

  • エージェントが別のエージェントをグループ通話に招待し、招待されたエージェントが招待を承諾してグループ通話に参加します。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "conferenced",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "connected"
  },
  {
    "ParticipantID" : "4321",
    "Type" : "agent",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

エージェントが電話会議から退出する

このイベントは、通話会議の参加者が通話会議を終了せずに退出したときにトリガーされます。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "participantDisconnect",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "disconnected"
  },
  {
    "ParticipantID" : "4321",
    "Type" : "agent",
    "State" : "connected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

通話がミュートされている

このイベントは、次のアクションによってトリガーされます。

  • エージェントが通話をミュートします。

  • エージェントが通話で他の参加者をミュートする。

このイベントはすべての通話に適用されます。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "connected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,\
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "muted"
  },
  {
    "ParticipantID" : "4321",
    "Type" : "agent",
    "State" : "muted"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

通話のミュートが解除された

このイベントは、次のアクションによってトリガーされます。

  • エージェントが通話のミュートを解除します。

  • エージェントが通話で他の参加者のミュートを解除します。

このイベントはすべての通話に適用されます。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "connected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "connected"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "unmuted"
  },
  {
    "ParticipantID" : "4321",
    "Type" : "agent",
    "State" : "unmuted"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

通話は編集されています

このイベントは、エージェントが通話を編集したときにトリガーされます。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "connected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "redacted"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "redacted"
  }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

通話が編集されていない

このイベントは、エージェントが通話の匿名化を解除したときにトリガーされます。

次のコードサンプルは、イベント ペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "connected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "unredacted"
   },
  {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "unredacted"
  }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

通話は終了しました

このイベントは、次のアクションによってトリガーされます。

  • エンドユーザーが通話を終了します。

  • エージェントが通話を終了します。

このイベントはすべての通話に適用されます。

次のコードサンプルは、着信通話イベントのペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "846802bf90d1",
  "State" : "disconnected",
  "Direction" : "incoming",
  "Initiator" : "+123456789",
  "Queue_path_ids": "1/2/3",
  "Queue_path_names" : "support/orders/status",
  "Language" : "en",
  "Queue_uuid" : 3,
  "Recording_permitted" : true,
  "Participants" :
  [
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "disconnected"
   },
   {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "disconnected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

次のコードサンプルは、アウトバウンド通話イベントのペイロードを示しています。

{
 "type" : "CallState",
 "item" : {
  "CallID" : "e9dd62bb",
  "State" : "disconnected",
  "Direction" : "outgoing",
  "Initiator" : "1234",
  "Participants" :
  [
   {
    "ParticipantID" : "1234",
    "Type" : "agent",
    "State" : "disconnected"
   },
   {
    "ParticipantID" : "+123456789",
    "Type" : "external",
    "State" : "disconnected"
   }
  ],
  "MediaID" : "208188811_124248155@67.231.1.110"
 }
}

通話セッション イベント フィールド

次の表は、コンタクト センター AI プラットフォームが QM アプリケーションにエクスポートするセッション データのフィールドについて説明しています。

一般フィールド

フィールド名 使用できる値 説明 効果
type
  • AgentState
  • CallState

JSON ペイロード全体のイベントタイプ。
  • エージェント関連のイベントの AgentState を渡します。
  • 通話関連イベントの CallState を渡します。

item

イベント情報を含むオブジェクト。

エージェントの状態フィールド

フィールド名 値 説明 動作

ParticipantID

エージェント ID

item オブジェクトで使用できます。

コンタクト センター AI プラットフォーム システム内のエージェントの識別子。
  • Contact Center AI Platform セッション メタデータの agent_info オブジェクトの ID フィールドの値を渡します。

Email

メールアドレス

item オブジェクトで使用できます。

エージェントのメールアドレス。
  • セッション メタデータの agent_info オブジェクトのメール フィールドの値を渡します。

State
  • login
  • logout

item オブジェクトで使用できます。

イベント発生時のエージェントの状態。
  • エージェントがログインしているときに login を渡します。
  • エージェントがログアウトしたときに logout を渡します。

通話状態フィールド

フィールド名 値 説明 動作

CallID

通話 ID

item オブジェクトで使用できます。

Contact Center AI プラットフォーム システムでの通話セッションの識別子。
  • Contact Center AI Platform セッション メタデータのメイン オブジェクトの ID フィールドの値を渡します。

State
  • dialing
  • waiting
  • ringing
  • connected
  • redirected
  • deflected
  • transferred
  • conferenced
  • disconnected

item オブジェクトで使用できます。

通話セッションの現在の状態。
  • エージェントまたはエンドユーザーへの発信通話が呼び出し中の状態の場合、dialing を渡します。
  • エージェントに投影するために通話がキューに入れられたときに waiting を渡します。
  • 着信/転送された通話がエージェントの投影状態にある場合に ringing を渡します。
  • エージェントまたはエンドユーザーが電話会議に接続されたときに connected を渡します。
  • 通話がエージェントに転送されずに自動的にリダイレクトされた場合、redirected を渡します。
  • エージェントから別のエージェントにコールド転送された場合に transferred を渡します。
  • エージェントから別のエージェントに引き継ぎ後に転送された場合に conferenced を渡します。
  • エージェントまたはエンドユーザーが電話会議から退出したときに disconnected を渡します。

Direction
  • incoming
  • outgoing

item オブジェクトで使用できます。

コンタクト センターの視点から見た通話セッションの方向。
  • 通話セッションがインバウンドの場合、incoming を渡します。
  • 通話セッションがアウトバウンドの場合、outgoing を渡します。

Initiator
  • エージェント ID
  • 仮想エージェント ID
  • エンドユーザーの電話番号

item オブジェクトで使用できます。

通話状態を初期化する当事者の識別子。

  • 人間のエージェントの場合

    セッション メタデータの agent_info オブジェクトの ID フィールドの値を渡します。

  • 仮想エージェントの場合

    セッション メタデータの参加者オブジェクトの virtual_agent_id フィールドの値を渡します。

  • エンドユーザーにとっての利点

    エンドユーザーの電話番号を渡します（利用可能な場合）。

    それ以外の場合は、セッション メタデータ内の end_user オブジェクトの ID フィールドの値を渡します。

Queue_path_ids

キュー ID のパス

item オブジェクトで使用できます。

通話の最初のエージェントに到達する前にエンドユーザーがたどったキューパス。

この値は、ナビゲートされたキューのキュー ID を使用して構築されます。

これは着信通話にのみ適用されます。

Queue_path_names

キュー名のパス

item オブジェクトで使用できます。

通話の最初のエージェントに到達する前にエンドユーザーがたどったキューパス。

この値は、ナビゲートされたキューのキュー名を使用して構築されます。

これは着信通話にのみ適用されます。

Language

言語コード

item オブジェクトで使用できます。

エンドユーザーが選択した言語の言語コード。

これは着信通話にのみ適用されます。

Queue_uuid

キュー ID

item オブジェクトで使用できます。

通話が到達するキューの UUID。

これは、着信通話とキュー転送通話にのみ適用されます。

Recording_permitted

ブール値

item オブジェクトで使用できます。

特定の通話で通話の録音が許可されているかどうかを示します
  • 通話の録音が許可されている場合は true を渡します。
  • 通話の録音が許可されていない場合、false を渡します。

Custom_headers

カスタム ヘッダー

item オブジェクトで使用できます。

このフィールドは、SIP ヘッダーなどのカスタムデータを渡すために使用されます

Participants

このオブジェクトは item オブジェクトにネストされています。

通話参加者の情報を含むオブジェクト。

ParticipantID
  • agent_id
  • virtual_agent_id
  • consumer_phoneNumber
  • thirdParty_phoneNumber

Participants オブジェクトで使用できます。

通話参加者の識別子。
  • 人間のエージェントの場合

    • Contact Center AI Platform セッション メタデータの agent_info オブジェクトの ID フィールドの値を渡します。

  • 仮想エージェントの場合

    • Contact Center AI Platform セッション メタデータの参加者オブジェクトの virtual_agent_id フィールドの値を渡します

  • エンドユーザーにとっての利点

    • エンドユーザーの電話番号を渡します（利用可能な場合）。

    それ以外の場合は、Contact Center AI Platform セッション メタデータの end_user object の id フィールドの値を渡します。

  • サードパーティの場合

    • サードパーティの電話番号を渡します（利用可能な場合）。

    それ以外の場合は、値 null を渡します。

Type
  • agent
  • external

Participants オブジェクトで使用できます。

通話参加者のタイプ。
  • 通話参加者が Contact Center AI Platform エージェントの場合、agent を渡します。
  • 通話参加者がエンドユーザーまたはサードパーティの場合、external を渡します。

State
  • dialing
  • ringing
  • connected
  • held
  • disconnected
  • callback
  • deflected
  • transferred
  • redacted
  • unredacted
  • muted
  • unmuted

Participants オブジェクトで使用できます。

電話会議における参加者の現在の状態。
  • 発信通話セグメントがエージェント、エンドユーザー、サードパーティのいずれかの呼び出し中状態の場合に dialing を渡します。
  • 着信または転送された通話セグメントがエージェントの投影状態にあるときに ringing を渡します。
  • エージェント、エンドユーザー、またはサードパーティが電話会議に接続されたときに connected を渡します。
  • エージェントが通話会議でエンドユーザーまたはサードパーティを保留にしたときに held を渡します。
  • エージェント、エンドユーザー、またはサードパーティが電話会議から退出したときに disconnected を渡します。
  • エージェント、エンドユーザー、またはサードパーティの通話セグメントで通話の編集が有効になっている場合に redacted を渡します
  • エージェント、エンドユーザー、サードパーティの通話セグメントで通話の編集が無効になっている場合は unredacted を渡します
  • エージェントがミュートに設定されている場合は muted を渡します
  • エージェントのミュートが解除されると unmuted を渡します

MediaID
  • twilio_mediaID
  • nexmo_mediaID

Participants オブジェクトで使用できます。

携帯通信会社からの通話セッション メディアの識別子。
  • 発信者が Twilio の番号に電話をかけるか、Twilio の番号から電話をかけると、twilio_mediaID を渡します。
  • イニシエータが Nexmo 番号に発信または Nexmo 番号から発信したときに nexmo_mediaID を渡します