APIを使用して、デスクトップアクティビティの画面録画を開始できます。 これにより、進行中のコンタクトがないときのエージェントの画面の録画や、バックオフィス画面の録画が可能になります。
このAPIは、Multi-ACD (Open)とCXone MpowerACDのユーザーが利用できます。
始める前に
これらのAPIの使用を開始する前に、ユーザー権限を設定し、アクセスキーを生成して、デベロッパーポータルで説明されている登録および認証プロセスに従ってください。
これらのAPIには、インタラクションハブの画面のインタラクションを記録権限が必要です。
POST画面のインタラクションの記録を開始します
APIは、アクティブコールに参加していない特定のユーザーの画面録画の開始を可能にします。 録音時間を指定するには、開始コマンドのパラメーターとして指定する必要があります。 長さは、5秒から最大許容時間の3時間30分までの間でなければなりません。 長さに到達すると、録音は自動的に停止します。 さらに、stop-screen-interaction-recordingコマンドを呼び出すことで、画面録画を停止できます。
-
録画が開始される（応答コード202で示される）か、成功する（応答コード200で示される）と、記録された画面に関連付けられたコンタクトIDが提供されます。 このコンタクトIDは、Stopコマンドを発行するときに使用する必要があります。
-
APIは、エージェントと顧客の間のライブ通話中に利用でき、録音される可能性があります。 そのような場合、2つの異なる録音が存在し、1つは音声会話をキャプチャし、もう1つはAPIインタラクションに基づいており、それぞれが異なるコンタクトIDに関連付けられています。
-
マスキングがライブコールに適用された場合、並行して記録される可能性のあるAPI画面録画のインタラクションにも影響します。
-
APIを使用する場合、画面録画のインスタンスは1つだけでもかまいません。 エージェントの画面がすでにAPI経由で録画されている場合、その同じエージェントに対する後続のAPI呼び出しは、新しい画面録画を生成せず、録画期間を更新しません。
| userId*： |
文字列 録音されるユーザーのID。 |
| recordingDuration*： |
番号 必要な録音時間を5～13200秒の範囲で指定します |
値と応答の例
POSTの例 /interaction-recording-management-service/interactions/start-screen-interaction-recording?user-id=1234567&recordingDuration=3000
応答
-
ステータス200—操作が正常に完了しました。
contactId（数値）：ACDのコンタクトID
InteractionId（文字列）：グローバルインタラクションID
-
ステータス202—操作は処理中です。
contactId（数値）：ACDのコンタクトID
InteractionId（文字列）：グローバルインタラクションID
-
ステータス400-不正なリクエスト。
-
ステータス401—リクエストしたユーザーが認証に失敗しました。
-
ステータス403—リクエストしたユーザーは操作の実行が認証されていません。
-
ステータス404—見つかりません。 アクティブなインタラクションは見つかりませんでした。
-
ステータス425—以前のリクエストの処理中にインタラクションがロックされました。
-
ステータス500—内部サーバーエラー。
-
ステータス504—リクエストがタイムアウトしました。
POST 画面インタラクションの記録を停止します
APIは、start-screen-interaction-recordingコマンドを使用して開始された、特定のユーザーのコンタクトIDの画面録画を停止できるようにします。 start-screen-interaction-recordingコマンドの応答で提供されるコンタクトIDを使用する必要があります。 このメソッドが呼び出されない場合、画面録画はstart-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—リクエストがタイムアウトしました。