このAPIを利用できるのは、CXone Multi-ACD (CXone Open) ユーザーのみです。
これらのAPIを使用すると、オンデマンドでコールレコーディングを開始、停止、無効化できるため、API経由でレコーディングを制御できます。
始める前に
Mask APIおよびUnmask APIの使用を開始する前に、ユーザー権限を設定し、アクセスキーを生成し、開発者ポータルで説明されている登録および認証プロセスに従ってください。
このAPIには、検索と再生 > API > マルチACD記録オンデマンドAPI権限が必要です。
POSTオンデマンドでレコーディングを開始
APIを使用すると、エージェントまたはアプリケーションは特定のユーザーの進行中のコールのレコーディングを開始できます。 コンプライアンス目的、品質保証、またはトレーニングに関連する特定のインタラクションや会話をキャプチャするために使用できます。
音声のみ、または音声と画面の両方のレコーディングを開始するように指定できます。 このAPIメソッドは、レコーディングポリシーよりも優先されます。
mediaTypeフラグはオプションであり、記録されるメディアタイプを制御できます。 サポートされている値はvoiceとvoiceAndScreenで、音声のみ、または音声と画面の両方のレコーディングを開始できます。 フラグが渡されない場合、デフォルト値はvoiceになります。
| userId*： |
文字列 レコーディングするメディアの種類。 |
値と応答の例POST /interaction-recording-management-service/interactions/start-recording-on-demand?user-id=1234567
応答
-
ステータス200—操作が正常に完了しました。 オンデマンドレコーディング開始リクエストが開始されました。
-
ステータス202—操作は処理中です。 オンデマンド開始リクエストが受け入れられ、処理されています。
-
ステータス400-不正なリクエスト
-
ステータス401—リクエストしたユーザーが認証に失敗しました。
-
ステータス403—リクエストしたユーザーは操作の実行が認証されていません。
-
ステータス404—見つかりません。 アクティブなインタラクションは見つかりませんでした。
-
ステータス409-サービス状態のため、リクエストを実行できません。
-
ステータス425-以前のオンデマンドレコーディング/オンデマンド停止リクエストの処理中にインタラクションがロックされました
-
ステータス500—内部サーバーエラー。
-
ステータス504—リクエストがタイムアウトしました。
POSTオンデマンドレコーディングを停止
このAPIにより、特定のユーザーの進行中のコールの音声と画面のレコーディングを停止できます。 これは、顧客のプライバシーを保護したり、特定の種類の会話のレコーディングを制限する規制に準拠したりするために使用できます。
このAPIメソッドは、レコーディングポリシーよりも優先されます。 オンデマンドレコーディング停止後の記録は、オンデマンドレコーディングの開始を呼び出すことによってのみ再開できます。
| userId*： |
文字列 レコーディングするエージェントのエージェントユーザーID。 |
値と応答の例POST /interaction-recording-management-service/interactions/stop-recording-on-demand?user-id=1234567
応答
-
ステータス200—操作が正常に完了しました。 オンデマンドレコーディング停止リクエストが開始されました。
-
ステータス202—操作は処理中です。 オンデマンド停止リクエストが受け入れられ、処理されています。
-
ステータス400-不正なリクエスト。
-
ステータス401—リクエストしたユーザーが認証に失敗しました。
-
ステータス403—リクエストしたユーザーは操作の実行が認証されていません。
-
ステータス404—見つかりません。 アクティブなインタラクションは見つかりませんでした。
-
ステータス409-サービス状態のため、リクエストを実行できません。
-
ステータス425-以前のオンデマンドレコーディング/オンデマンド停止リクエストの処理中にインタラクションがロックされました。
-
ステータス500—内部サーバーエラー。
-
ステータス504—リクエストがタイムアウトしました。
POSTコールをレコーディングするオプションを無効にする
APIを使用すると、顧客が同意を拒否し、レコーディングに同意しない場合に、コールの音声と画面をレコーディングするオプションを無効にすることができます。 これは、EU一般データ保護規則(GDPR)に特に対応したものです。 顧客が同意を拒否した場合には、コールをレコーディングするレコーディングポリシーが設定されている場合や、エージェントがオンデマンドで、またはAPIを使用してコールをレコーディングしている場合でも、CXone Recordingはコールをレコーディングしません。
APIコール後は、転送、コンサルト、会議を含む顧客とのコンタクト全体についてレコーディングを開始することはできません。 コールレコーディング中にAPIが呼び出された場合、CXone Recordingはレコーディングを停止しますが、コールのレコーディングされた部分は検索および再生できるようになります。
レコーディングの同意は現在のコールにのみ適用されます。 顧客との将来のインタラクションのために保存されることはありません。
| userId*： |
文字列 レコーディングするエージェントのエージェントユーザーID。 |
値と応答の例POST /interaction-recording-management-service/interactions/do-not-record?user-id=1234567
応答
-
ステータス200—操作が正常に完了しました。 レコーディング禁止リクエストが開始されました。
-
ステータス202—操作は処理中です。 レコーディング禁止リクエストが受け入れられ、処理されています。
-
ステータス400-不正なリクエスト。
-
ステータス401—リクエストしたユーザーが認証に失敗しました。
-
ステータス403—リクエストしたユーザーは操作の実行が認証されていません。
-
ステータス404—見つかりません。 アクティブなインタラクションは見つかりませんでした。
-
ステータス409-サービス状態のため、リクエストを実行できません。
-
ステータス425—以前のリクエストの処理中にインタラクションがロックされました。
-
ステータス500—内部サーバーエラー。
-
ステータス504—リクエストがタイムアウトしました。