Record on Demand API

この API は、音声または画面録画機能を持つ Engagement Hub ユーザーが使用できます。

これらのAPIを使用すると、オンデマンドでコールレコーディングを開始、停止、無効化できるため、API経由でレコーディングを制御できます。

Record on Demand APIのドキュメントは、Developer Communityポータルで入手できます。

始める前に

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

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

また、このAPIを使用するには、Interactions Hub >API > Multi-ACD Record on Demand API権限が必要です。

オンデマンド録音を開始する

APIを使用すると、エージェントまたはアプリケーションは特定のユーザーの進行中のコールのレコーディングを開始できます。コンプライアンス目的、品質保証、またはトレーニングに関連する特定のインタラクションや会話をキャプチャするために使用できます。

音声のみ、または音声と画面の両方のレコーディングを開始するように指定できます。このAPIメソッドは、レコーディングポリシーよりも優先されます。

mediaTypeフラグはオプションであり、記録されるメディアタイプを制御できます。サポートされている値はvoiceとvoiceAndScreenで、音声のみ、または音声と画面の両方のレコーディングを開始できます。フラグが渡されない場合、デフォルト値はvoiceになります。

方法:POST

エンドポイント: /interaction-recording-management-service/interactions/start-recording-on-demand

パラメータ:

userId*：

文字列

レコーディングするメディアの種類。

値と応答の例

POST /interaction-recording-management-service/interactions/start-recording-on-demand?user-id=1234567

応答

ステータス 200 - 操作は成功しました。オンデマンドレコーディング開始リクエストが開始されました。
ステータス202-処理中。オンデマンド開始リクエストが受け入れられ、処理されています。
ステータス 400 - 不正なリクエスト
ステータス401:要求元のユーザーは認証に失敗しました。
ステータス 403 - 要求元のユーザーには、操作を実行する権限がありません。
ステータス404 - 見つかりません。アクティブなインタラクションは見つかりませんでした。
ステータス409 - サービス状態のため、リクエストを実行できません。
ステータス425-前のレコードオンデマンド/オンデマンド停止リクエストの処理中にインタラクションがロックされます
ステータス500 - 内部サーバーエラー。
ステータス504 - リクエストがタイムアウトしました。

オンデマンドでのレコーディング停止

このAPIにより、特定のユーザーの進行中のコールの音声と画面のレコーディングを停止できます。これは、顧客のプライバシーを保護したり、特定の種類の会話のレコーディングを制限する規制に準拠したりするために使用できます。

このAPIメソッドは、Recordingポリシーよりも優先されます。オンデマンドレコーディング停止後の記録は、オンデマンドレコーディングの開始を呼び出すことによってのみ再開できます。

方法:POST

エンドポイント: /interaction-recording-management-service/interactions/stop-recording-on-demand

パラメータ:

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 - リクエストがタイムアウトしました。

通話を録音するオプションを無効にします

APIを使用すると、顧客が同意を拒否し、レコーディングに同意しない場合に、コールの音声と画面をレコーディングするオプションを無効にすることができます。これは、EU一般データ保護規則(GDPR)に特に対応したものです。顧客が同意を拒否した場合、通話を録音するために設定されたレコーディングポリシーがある場合、エージェントがオンデマンドまたはAPIを使用して通話を録音した場合でも、CXone MpowerRecordingは通話を録音しません。

APIコール後は、転送、コンサルト、会議を含む顧客とのコンタクト全体についてレコーディングを開始することはできません。コールレコーディングの進行中にAPIが呼び出された場合、Recordingはレコーディングを停止し、コールの録音された部分が検索と再生に利用できるようになります。

レコーディングの同意は現在のコールにのみ適用されます。顧客との将来のインタラクションのために保存されることはありません。

方法:POST

エンドポイント: /interaction-recording-management-service/interactions/do-not-record

パラメータ:

userId*：

文字列

レコーディングするエージェントのエージェントユーザーID。

値と応答の例

POST /interaction-recording-management-service/interactions/do-not-record?user-id=1234567

応答

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