画面インタラクションレコーディングAPI

APIを使用して、デスクトップアクティビティの画面記録を開始できます。これにより、進行中のコンタクトがないときのエージェントの画面の録画や、バックオフィス画面の録画が可能になります。

このAPIは、音声または画面録画機能を持つエンゲージメントハブユーザー、およびCXone MpowerACDユーザーが利用できます。

始める前に

CXone Mpower開発者ポータルでAPIをテストできます。 CXone Mpowerアカウントでログインすると、アカウントのテナント CXone Mpowerシステムにおけるテクニカルサポート、請求、およびグローバル設定を管理するために使用される上位レベルの組織グループ。でリクエストを行うことができます。

APIの使用を開始するには、認証に使用される有効な認証情報を受け取るためにNiCEに登録する必要があります。手順については、開発者ポータルのはじめにページを参照してください。

また、これらのAPIを使用するには、Interactions Hub 画面インタラクションの記録権限が必要です。

画面インタラクションの記録を開始する

APIは、アクティブコールに参加していない特定のユーザーの画面録画の開始を可能にします。録音時間を指定するには、開始コマンドのパラメーターとして指定する必要があります。長さは、5秒から最大許容時間の3時間30分までの間でなければなりません。長さに到達すると、録音は自動的に停止します。さらに、stop-screen-interaction-recordingコマンドを呼び出すことで、画面録画を停止できます。

録画が開始される（応答コード202で示される）か、成功する（応答コード200で示される）と、記録された画面に関連付けられたコンタクトIDが提供されます。このコンタクトIDは、Stopコマンドを発行するときに使用する必要があります。
APIは、エージェントと顧客の間のライブ通話中に利用でき、録音される可能性があります。そのような場合、2つの異なる録音が存在し、1つは音声会話をキャプチャし、もう1つはAPIインタラクションに基づいており、それぞれが異なるコンタクトIDに関連付けられています。
マスキングがライブコールに適用された場合、並行して記録される可能性のあるAPI画面録画のインタラクションにも影響します。
APIを使用する場合、画面録画のインスタンスは1つだけでもかまいません。エージェントの画面がすでにAPI経由で録画されている場合、その同じエージェントに対する後続のAPI呼び出しは、新しい画面録画を生成せず、録画期間を更新しません。

方法:POST

エンドポイント:/interaction-recording-management-service/v1/interactions/start-screen-interaction-recording

パラメーター:

userId*：

(クエリ)

文字列

録音されるユーザーのID。

recordingDuration*：

(クエリ)

番号

必要な録音時間を5～13200秒の範囲で指定します

値と応答の例

POST /interaction-recording-management-service/interactions/start-screen-interaction-recording?user-id=1234567&recordingDuration=3000

応答

ステータス 200 - 操作は成功しました。

description (文字列): 応答の説明。

contactId(番号):ACDコンタクトID。

interactionId(文字列):グローバルインタラクションID。

httpStatus (文字列): HTTP ステータスの説明。
ステータス202-操作中です。

contactId(番号):ACDコンタクトID。

interactionId(文字列):グローバルインタラクションID。

httpStatus (文字列): HTTP ステータスの説明。
ステータス 400 - 不正なリクエスト。
ステータス401:要求元のユーザーは認証に失敗しました。
ステータス 403 - 要求元のユーザーには、操作を実行する権限がありません。
ステータス404 - 見つかりません。アクティブなインタラクションは見つかりませんでした。
ステータス425 - 前のリクエストの処理中にインタラクションがロックされます。
ステータス500 - 内部サーバーエラー。
ステータス504 - リクエストがタイムアウトしました。

画面インタラクションの記録を停止する

APIは、start-screen-interaction-recordingコマンドを使用して開始された、特定のユーザーのコンタクトIDの画面録画を停止できるようにします。 start-screen-interaction-recordingコマンドの応答で提供されるコンタクトIDを使用する必要があります。このメソッドが呼び出されない場合、画面録画はstart-screen-interaction-recordingコマンドで指定された期間後に自動的に停止します。

方法:POST

エンドポイント:/interaction-recording-management-service/v1/interactions/stop-screen-interaction-recording

パラメーター:

userId*：

文字列

停止する記録されたユーザーのID。

contactId*：

番号

スタート画面録画コマンドで返されたコンタクトID。

値と応答の例

POST /interaction-recording-management-service/interactions/stop-screen-interaction-recording?user-id=1234567&contactId=1122334455

応答

ステータス 200 - 操作は成功しました。
ステータス202-操作中です。
ステータス 400 - 不正なリクエスト。
ステータス401:要求元のユーザーは認証に失敗しました。
ステータス 403 - 要求元のユーザーには、操作を実行する権限がありません。
ステータス404 - 見つかりません。アクティブなインタラクションは見つかりませんでした。
ステータス425 - 前のリクエストの処理中にインタラクションがロックされます。
ステータス500 - 内部サーバーエラー。
ステータス504 - リクエストがタイムアウトしました。