データ抽出API

データ抽出APIを使用すると、外部レポートの目的でCXone Mpowerからデータを抽出できます。 たとえば、抽出することができますQMワークフローデータ、 QM質問と回答のデータ、 Recordingインタラクションメタデータ、またはWFM給与データ。 データは、指定された日付範囲に従ってのみフィルタリングできます。

Data 抽出 APIを試して、開発者ポータル でドキュメントを確認できます。

POST /jobsを呼び出すと、データの準備中に jobId が返されます。 データの準備ができているかどうかを確認するには、エンドポイント /jobs/{jobId}からサービスをポーリングして、ジョブのステータスを返します。 ステータスが成功の場合、追加のURLも返されます。 URLには30秒間アクセスできます（ファイルのダウンロードにかかる時間は含まれません）。

毎回手動でデータを取得する代わりに、APIを定期的に呼び出すスクリプトを作成できます。 常に、テナントごとに1人のユーザーのみがAPIを呼び出すことができます。 30秒間に1回だけAPIを呼び出すことができます。

始める前に

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

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

これらのAPIを使用量するには、次の権限が必要です。

  • エンティティ：

    • [インタラクションメタデータ]を抽出する場合は、[検索と再生] > [API] > [インタラクションメタデータの抽出]権限が必要です。

    • QMワークフローデータ抽出する場合は、 QMツール>データ抽出API > QMワークフローAPIの権限が必要です。

    • QMQ＆Aデータを抽出する場合は、 QMツール>データ抽出API > QMワークフローAPIの権限が必要です。

    • WFM給与データを抽出する場合、WFM > データ抽出API > WFMペイロールAPIの権限が必要です。

    • 評価者メモQM抽出する場合は、QMツール > Data 抽出 API > QM評価者メモAPI権限が必要です。

求人を得る

テナントごとのすべてのジョブステータスのリストを表示します。 可能なステータスは実行中、成功、失敗、キャンセルおよび期限切れです。

メソッド:GET

エンドポイント: /data-extraction/v1/jobs

パラメーター:なし

値の例

 "jobs": [ { "id": "9dd92a83-1234-8549-8df4-939485722942", "status": "RUNNING" }, { "id": "12345d5h-c099-2345-k3r3-w3ko9ppp1234", "status": "FAILED" } ] }

応答

  • ステータス200 - 成功。 すべてのジョブの取得されたステータス。

  • ステータス401-未承認。 無効な資格情報。

  • ステータス403-禁止。 ユーザーにはジョブのステータスを表示する権限がありません。

  • ステータス500-内部サーバーエラー。

ジョブの準備

データの抽出申請が行われた後、データが収集され、抽出の準備が行われます。 データは、S3でCSVファイルとして24時間利用できます。 完了すると、ジョブIDが返されます。

方法:POST

エンドポイント: /data-extraction/v1/jobs

パラメーター:なし

申請本文*： application/json

exportRequest {
説明：

 

データを抽出するために提供する必要があるパラメータ。
entityName

文字列

抽出するエンティティの名前。 正しいエンティティ名については、以下を参照してください。
バージョン

文字列

抽出するエンティティのバージョン。 各エンティティの正しいバージョンについては、以下を参照してください。
startDate

文字列（$date）

データの抽出を開始する日付（UTC）。 日付形式は<YYYY-MM-DD>です。 たとえば、2019年5月22日からデータを抽出するには、日付を2019-05-22と入力します。
endDate

文字列（$date）

データの抽出を停止する日付（UTC）。 日付形式は<YYYY-MM-DD>。 たとえば、2019年5月29日までのデータを抽出するには、日付を2019-05-29と入力します。
}  

値の例

{ "entityName": "qm-workflows", "version": "3", "startDate": "2019-05-22", "endDate": "2019-05-29" }

応答

  • ステータス202 - 成功。 非同期ジョブが正常にエクスポートされました。

    文字列

    例：12345d5h-c099-9303-j99j-w3ko9ppp1234

  • ステータス400 - リクエストが無効です。 不正な日付フィルタなど

  • ステータス401-未承認。 無効な資格情報。

  • ステータス403-禁止。 ユーザーにはジョブのステータスを表示する権限がありません。

  • ステータス404-見つかりません。 エンティティがないか、バージョンが無効です。

  • ステータス500-内部サーバーエラー。

ジョブ ジョブIDによるジョブの取得

ジョブIDごとに特定のジョブのステータスを表示します。 ジョブが成功した場合、抽出されたデータにアクセスするためのURLが返され、30秒間アクセスできます（ファイルのダウンロードにかかる時間は含まれません）。 ジョブが失敗した場合、エラーメッセージが返されます。 リンクを使用して、抽出されたデータにアクセスできます。 可能なジョブステータスは、実行中、成功、失敗、キャンセルおよび期限切れです。

メソッド:GET

エンドポイント: /data-extraction/v1/jobs

パラメーター:

jobId*：

文字列

顧客データを抽出するために行われたリクエストの一意の識別子。

値の例

 12345d5h-r3ds-9303-0pw3-w3ko9ppp1234

応答

  • ステータス202 - 成功。 取得したジョブのステータス。

     jobResponse{ description: Displays the job status jobStatus: { description: Job Status, includes job ID and job status id:	string Unique identifier of the job. status: string example: SUCCEEDED Job status that can be returned. Enum: [ RUNNING, SUCCEEDED, FAILED, CANCELLED, EXPIRED ] result: { description:	Job result. If successful, contains the url, if failed, an error message is displayed. url: string example: https://s3.example.amazonaws.com/results-bucket/data-extraction/{details} A url to access the extracted data is returned when a job for extracting data is successful. errorMessage: string Error message displayed when a request for extracting data fails. } } }

  • ステータス400 - リクエストが無効です。 不正な日付フィルタなど

  • ステータス401-未承認。 無効な資格情報。

  • ステータス403-禁止。 ユーザーにはジョブのステータスを表示する権限がありません。

  • ステータス404-見つかりません。 エンティティがないか、バージョンが無効です。

  • ステータス500-内部サーバーエラー。

QMワークフローエンティティとCSVファイル

QMワークフローAPIを使用すると、評価、自己評価、キャリブレーションなどのQMワークフローデータを抽出できます。

POSTジョブの場合：

  • entityNameは：qm-workflows

  • バージョン：4

データは提出日（UTC）でフィルタリングされます。

列名

説明

テナント名

テナントの名前。

エージェントID

エージェントの一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列

タイプ

評価のタイプ。例：

  • 評価

  • 自己評価

フィールドタイプ：最大24文字(VARCHAR)の文字列

評価フロートリガー

評価を開始したイベント：

  • 調整

  • 共同

  • マニュアル

  • QP

フィールドタイプ：最大24文字(VARCHAR)の文字列

ワークフローステータス

ワークフローのステータス：

  • エージェントに送信

  • レビュー中

  • 異議

  • 完了認識済

  • 完全な自己評価

  • 完了レビュー済

  • 完了レビューなし

  • 完了

  • 削除済

  • 削除済み-完了

  • 期限切れ

  • 削除済み-期限切れ

  • 削除済み-完了認識済

  • 削除済-完了レビュー済

  • 削除済み-完了レビューなし

フィールドタイプ：最大128文字(VARCHAR)の文字列

自動確認済み

可能な値は次のとおりです。

  • TRUE：エージェントが評価を承認しなかった場合、自動的に承認されました。

  • FALSE：エージェントが評価を承認した場合。

  • 空の値：自己評価の場合、確認は必要ありません。

フィールドタイプ：ブーリアン

ワークフロー状態

ワークフローのステータス：

  • 営業時間内

  • クローズ済

  • タイムアウトしました

フィールドタイプ：最大128文字(VARCHAR)の文字列

ワークフローID

評価の一意の識別子。

フィールドタイプ: 最大36文字(VARCHAR)の文字列

APIバージョン: 3以上

プラン名

この評価を開始するために使用された品質計画の名前。

フィールドタイプ：最大128文字(VARCHAR)の文字列

フォーム名

この評価に使用されたフォームの名前。

フィールドタイプ：最大256文字(VARCHAR)の文字列

フォームバージョン

この評価に使用された評価フォームのバージョン。

フィールドタイプ: 数値(4.0)

開始日

この評価が開始された日時（UTC）。

フィールドタイプ: TIMESTAMP_LTZ(3)

提出日

この評価が送信された日時（UTC）。

フィールドタイプ: TIMESTAMP_LTZ(3)

最終更新

この評価が最後に変更された時のタイムスタンプ（UTC）。

フィールドタイプ: TIMESTAMP_LTZ(3)

不服申し立ての場合は、提出日ではなく、最終更新をプルします。

スコア - パーセンテージ

評価スコアをパーセンテージで表示します。

フィールドタイプ：FLOAT

スコア

評価スコア。

フィールドタイプ：FLOAT

最大可能スコア

評価フォームの各質問で可能な最高のスコア。

フィールドタイプ：FLOAT

ランク

フォームのランクを定義するためにユーザーが設定する値のカスタム範囲。

フィールドタイプ：最大256文字(VARCHAR)の文字列

失敗した重要な質問

値が真の場合、ユーザーは重要な質問に失敗し、評価フォームのスコアはゼロに設定されます。

値が偽の場合、ユーザーは質問に正しく回答しました。

フィールドタイプ：ブーリアン

ユーザーレビューコメント

評価の係争中にユーザー（エージェント）が入力したコメント。

フィールドタイプ：最大256文字(VARCHAR)の文字列

紛争解決者のコメント

異議申し立ての終了時にユーザー（マネージャー/評価者）が入力したコメント。

フィールドタイプ：最大256文字(VARCHAR)の文字列

セグメントID

評価されているインタラクションのセグメントID。

フィールドタイプ：最大36文字(VARCHAR)の文字列

ACD ID

自動コールディストリビュータの一意の識別子。

フィールドタイプ：数値(38.0)

インタラクションタイプ

インタラクションタイプ：

  • PHONE_CALL

  • Eメール

  • チャット

  • SMS

  • WORKITEM

  • GOOGLE_BUSINESS_MESSAGES_PRIVATE

  • APPLE_BUSINESS_CHAT_PRIVATE

  • TELEGRAM_PRIVATE

  • LINE_PRIVATE

  • WHATSAPP_PRIVATE

  • SLACK_PRIVATE

  • MICROSOFT_TEAMS_PRIVATE

  • TW_PRIVATE

  • VIBER_PRIVATE

  • CUSTOM_PRIVATE

  • WE_CHAT_PRIVATE

  • FB_PRIVATE

フィールドタイプ：最大50文字(VARCHAR)の文字列

インタラクション開始日

インタラクションの開始日時（UTC）。

フィールドタイプ：TIMESTAMP_LTZ(6)

インタラクション終了日

インタラクションの終了日時（UTC）。

フィールドタイプ：TIMESTAMP_LTZ(6)

インタラクションの方向

電話の方向：

  • インバウンド

  • アウトバウンド

フィールドタイプ：最大50文字(VARCHAR)の文字列

チームID

エージェントのチームの一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列

チーム名

エージェントのチーム名。

フィールドタイプ：最大50文字(VARCHAR)の文字列

電話番号

顧客の電話番号。

フィールドタイプ：最大200文字(VARCHAR)の文字列

FirstName（評価）

評価者の名。

フィールドタイプ：最大255文字(VARCHAR)の文字列

LastName（評価）

評価者の姓。

フィールドタイプ：最大255文字(VARCHAR)の文字列

FirstName（エージェント）

評価されたエージェントの名。

フィールドタイプ：最大255文字(VARCHAR)の文字列

LastName（エージェント）

評価されたエージェントの姓。

フィールドタイプ：最大255文字(VARCHAR)の文字列

FirstName（表示）

紛争解決者の名。

フィールドタイプ：最大255文字(VARCHAR)の文字列

LastName（表示）

紛争解決者の姓。

フィールドタイプ：最大255文字(VARCHAR)の文字列

FirstName（割り当て者）

評価を割り当てたユーザーの名。

フィールドタイプ：最大255文字(VARCHAR)の文字列

LastName（割り当て者）

評価を割り当てたユーザーの姓。

フィールドタイプ：最大255文字(VARCHAR)の文字列
理由

評価を削除した理由。

フィールドタイプ：最大128文字(VARCHAR)の文字列

APIバージョン: 4以上
親ID

コラボレーションや調整などの評価の親ワークフローID。

フィールドタイプ：最大36文字(VARCHAR)の文字列

APIバージョン: 4以上
評価件名

可能な値は次のとおりです。

  • 従業員

  • セグメント

フィールドタイプ：最大128文字(VARCHAR)の文字列

APIバージョン: 4以上

QM質問と回答（Q＆A）エンティティとCSVファイル

QM質疑応答APIを使用すると、QM評価、自己評価、およびキャリブレーションから質問と回答を抽出できます。

POSTジョブの場合：

  • entityNameは：qm-questions

  • バージョンは：2です

データは提出日（UTC）でフィルタリングされます。

列名

説明

質問ID

質問の一意の識別子。

フィールドタイプ: 数値(38.0)
質問のタイトル

質問のテキスト。

フィールドタイプ：最大2048文字(VARCHAR)の文字列
質問番号

評価フォームの質問の番号。

フィールドタイプ：最大15文字(VARCHAR)の文字列
回答

質問に対する評価者の回答。

フィールドタイプ：最大10000文字(VARCHAR)の文字列
オプション

はい/いいえ、数値オプション、ラジオボタンオプションなど、質問に使用できる回答オプション。

フィールドタイプ：ARRAY
フォームID

評価フォームの一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列

フォーム名

この評価に使用されたフォームの名前。

フィールドタイプ：最大256文字(VARCHAR)の文字列

フォームバージョン

この評価に使用された評価フォームのバージョン。

フィールドタイプ: 数値(4.0)
評価開始日

この評価が開始された日時（UTC）。

フィールドタイプ: TIMESTAMP_LTZ(3)
評価提出日

この評価が送信された日時（UTC）。

フィールドタイプ: TIMESTAMP_LTZ(3)

異議申し立ての場合は、最終変更日ではなく、提出日を取得します。

ワークフローのタイプ

評価のタイプ。例：

  • 評価

  • 自己評価

フィールドタイプ：最大24文字(VARCHAR)の文字列
セクションID 評価フォームのセクションの一意の識別子。

フィールドタイプ: 数値(38,0)
セクションのタイトル

評価フォームのセクションの名前。

フィールドタイプ：最大2048文字(VARCHAR)の文字列
スコア

質問にスコアを付けることができるかどうかの真または偽のフラグ。

フィールドタイプ：ブーリアン
実際のスコア

エージェントが質問で受け取ったスコア。

フィールドタイプ：FLOAT
セクションスコア（%）

質問が配置されたセクションのパーセンテージスコア。

フィールドタイプ：FLOAT
最大スコア

エージェントが質問で受け取ることができた最大スコア。

フィールドタイプ：FLOAT

エージェントID

エージェントの一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列

FirstName（エージェント）

評価されたエージェントの名。

フィールドタイプ：最大255文字(VARCHAR)の文字列

LastName（エージェント）

評価されたエージェントの姓。

フィールドタイプ：最大255文字(VARCHAR)の文字列

チームID

エージェントのチームの一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列

チーム名

エージェントのチーム名。

フィールドタイプ：最大50文字(VARCHAR)の文字列

FirstName（評価）

評価者の名。

フィールドタイプ：最大255文字(VARCHAR)の文字列

LastName（評価）

評価者の姓。

フィールドタイプ：最大255文字(VARCHAR)の文字列
重大

質問が重要な質問であったかどうかの真または偽のフラグ。

フィールドタイプ：ブーリアン

失敗した重要な質問

値が真の場合、ユーザーは重要な質問に失敗し、評価フォームのスコアはゼロに設定されます。

値が偽の場合、ユーザーは質問に正しく回答しました。

フィールドタイプ：ブーリアン
必須

質問が必須であったかどうかの真または偽のフラグ。

フィールドタイプ：ブーリアン
質問タイプ

質問の種類：

  • ラジオボタン

  • はい/いいえ

  • チェックボックス

  • ドロップダウン

  • 日付/時刻

フィールドタイプ：最大64文字(VARCHAR)の文字列

セグメントID

評価されているインタラクションのセグメントID。

フィールドタイプ：最大36文字(VARCHAR)の文字列

インタラクション開始日

インタラクションの開始日時（UTC）。

フィールドタイプ：TIMESTAMP_LTZ(6)

インタラクション終了日

インタラクションの終了日時（UTC）。

フィールドタイプ：TIMESTAMP_LTZ(6)

WorkflowInstance ID

評価の一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列

評価スコア（%）

評価のパーセンテージスコア。

フィールドタイプ：FLOAT

バンクID

質問が配置されている質問バンクの一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列
非表示の名前

Trueフラッグは質問を隠し、Falseフラッグは質問を表示します。 品質フォームでQMフォームルールを使用すると、前の質問のスコアに基づいてフォローアップ質問が非表示になります。

フィールドタイプ：ブーリアン

APIバージョン：2以上

QM評価者メモとCSVファイル

QM評価者メモAPIを使用すると、QM評価者メモを抽出できます。

POSTジョブの場合：

  • entityName ：qm-evaluation-comment-entity

  • バージョン：1

データは提出日（UTC）でフィルタリングされます。

列名

説明

コメントID

コメントの一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列

コメント

コメントのテキスト。

フィールドタイプ：最大300文字(VARCHAR)の文字列

コメント時間

コメントが追加された日時。

フィールドタイプ: TIMESTAMP_LTZ(3)

アクティビティ

コメントが追加されたときの評価アクション名。

フィールドタイプ：最大50文字(VARCHAR)の文字列

ID別のコメント

コメントを追加したユーザーの一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列

FirstNameによるコメント

コメントを追加したユーザーの名。

フィールドタイプ：最大255文字(VARCHAR)の文字列

LastNameによるコメント

コメントを追加したユーザーの姓。

フィールドタイプ：最大255文字(VARCHAR)の文字列

質問ID

質問の一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列

質問のタイトル

質問のテキスト。

フィールドタイプ：最大2048文字(VARCHAR)の文字列

フォームID

評価フォームの一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列

フォーム名

評価に使用されたフォームの名前。

フィールドタイプ：最大256文字(VARCHAR)の文字列

フォームバージョン

評価に使用された評価フォームのバージョン。

フィールドタイプ: 数値(4.0)

ワークフローID

評価の一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列

ワークフローステータス

ワークフローのステータス。

フィールドタイプ：最大128文字(VARCHAR)の文字列

エージェントID

エージェントの一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列

FirstName（エージェント）

エージェントの名。

フィールドタイプ：最大255文字(VARCHAR)の文字列

LastName（エージェント）

エージェントの姓。

フィールドタイプ：最大255文字(VARCHAR)の文字列

チームID

エージェントのチームの一意の識別子。

フィールドタイプ：最大36文字(VARCHAR)の文字列

チーム名

エージェントのチーム名。

フィールドタイプ：最大50文字(VARCHAR)の文字列

インタラクションメタデータエンティティとCSVファイル

対話メタデータAPIを使用すると、 Recording対話メタデータを抽出できます。

POSTジョブの場合：

  • entityNameは：recording-interaction-metadata

  • バージョンは10です

  • データを日時でフィルターするには、yyyy-mm-dd hh:mm:ssの形式でUTCのstartDateとendDateを使用します。

列名

説明

ACDコールID（例：マスターコンタクトID）

ACDコールIDはACDソリューションによって異なります。たとえば、これはCXone MpowerマスターコンタクトIDクローズ済 1つまたは複数の関連するコンタクトのマスターまたは親ID。コンタクトが3回以上転送されると、新しいマスターコンタクトIDが割り当てられます。と同じです 。

フィールドタイプ: 最大38桁を含む数値

セグメントID

セグメントの一意の識別子。 セグメントは、顧客とエージェントなどの当事者二人とのインタラクションです。

フィールドタイプ: 最大36文字(VARCHAR UUID)の文字列

セグメント開始理由

セグメントが開始された理由：

  • 会議

  • IVR

  • セグメント：コンタクトの最初のセグメント

  • 転送

  • コンタクト

  • エレベーション済

  • 外部番号に転送

  • 外部転送

フィールドタイプ：最大100文字(VARCHAR)の文字列

セグメント終了理由

セグメントが終了した理由：

  • 会議

  • IVR

  • セグメント：コンタクトの最後のセグメント

  • 転送

  • コンタクト

  • エレベーション済

  • 外部番号に転送

  • 外部転送

フィールドタイプ：最大100文字(VARCHAR)の文字列
方向

セグメントの方向：

  • インバウンド

  • アウトバウンド

  • 内部

  • 不明

フィールドタイプ：最大150文字(VARCHAR)の文字列

開始日

セグメントの開始日時(UTC)。

フィールドタイプ: タイムスタンプ

終了日

セグメントの終了日時(UTC)。

フィールドタイプ: タイムスタンプ
チャネルタイプ

インタラクションタイプ：

  • 音声

  • チャット

  • Eメール

  • IVR

  • ワークアイテム

  • SMS

  • メッセージングチャネル:Facebook Messenger、WhatsApp、Apple Messages for Business(Appleビジネスチャット)、LINEメッセージング、Telegramメッセンジャー、Viberメッセンジャー、カスタム、Microsoft Teams、Slack。

  • パブリックソーシャルチャネル:Facebook、Googleプレイス、Google Play、LinkedIn、YouTube、Appleアプリレビュー、カスタム(パブリック)。

フィールドタイプ：最大150文字(VARCHAR)の文字列
画面録画

セグメントに画面録画が含まれる場合：

  • はい

  • いいえ
音声録音ステータス

録画ステータス：

  • 成功

  • 部分的に録音しました：このセグメントの一部は録音されませんでしたが、インタラクションは引き続き再生できます

  • どのポリシーにも一致しない:記録なし - このインタラクションによってトリガーされた記録ポリシーはありません

  • 記録率のために記録されません:記録なし-このインタラクションによって記録ポリシーがトリガーされましたが、ポリシーで定義された記録率のために記録されませんでした

  • 記録しないポリシー:記録なし - このインタラクションに対して記録しないポリシーがトリガーされました

  • IVRでの同意の拒否：レコーディングはありません

  • 失敗：レコーディングはありません

  • マスク:記録なし-記録はマスクされました

  • 外線に転送されたレコードが選択されていません：レコーディングはありません

  • 録音可能(音声)が選択されていない:録音なし - エージェント属性録音可能(音声)が選択されていません

フィールドタイプ：最大250文字(VARCHAR)の文字列
画面録画ステータス

録画ステータス：

  • 成功

  • 部分的に録音しました：このセグメントの一部は録音されませんでしたが、インタラクションは引き続き再生できます

  • どのポリシーにも一致しない:記録なし - このインタラクションによってトリガーされた記録ポリシーはありません

  • 記録率のために記録されません:記録なし-このインタラクションによって記録ポリシーがトリガーされましたが、ポリシーで定義された記録率のために記録されませんでした

  • 記録しないポリシー:記録なし - このインタラクションに対して記録しないポリシーがトリガーされました

  • IVRでの同意の拒否：レコーディングはありません

  • 失敗：レコーディングはありません

  • マスク:記録なし-記録はマスクされました

フィールドタイプ：最大250文字(VARCHAR)の文字列

レコーディングアラート

レコーディングアラートには次のものがあります。

  • ScreenAgentに到達できません:ScreenAgentが正しく設定されていないか、実行されていません。

  • 画面録画エラー:

    • 通話が完全に録音されていない可能性があります

    • 画面録画エラー

    • ScreenAgent マシン構成エラー

    • ScreenAgentとエージェントの画面の間に接続がない

    • ScreenAgent マシンのネットワーク構成エラー

    • ScreenAgentは、マシン構成のため、録画を開始しませんでした

    • ScreenAgentは、自己署名証明書の設定により、録画のアップロードに失敗しました

    • ScreenAgentマシンのハードドライブ構成エラー

    • ScreenAgentが最大並列通話数に達しました

    • 画面録画が最大通話時間に達しました

      「ScreenAgent問題の解決」を参照してください。

  • 録音が短すぎます:

    • 画面録画が短すぎます。

    • 音声は4秒未満で、録音できない場合があります。

  • メディアサーバーへの接続なし：メディアサーバーに問題があり、利用可能な録画がありません。 このエラーはさまざまな理由で発生する可能性があり、録音・録画アラートのエラーの説明に詳細な情報が記載されています。 Multi-ACD (Open)ソリューションで、このエラーは、顧客からのSIPイベントが欠落していることを示します。 これは、招待全体が欠落しているか、片側（近距離または遠距離）のみを受信していることを意味する可能性があります。

  • 音声レコーダーが通話を録音できません：録音はありません。 音声レコーダーに問題がありました。 複数の理由がある場合があります。 録音アラートのエラー説明には、より詳細な情報が記載されています。

  • オーディオを使用できません：不完全なオーディオデータ-このインタラクションではオーディオを使用できません（不完全なオーディオデータ）。 CXone Mpowerサポートに連絡してください。

  • 音声が利用できません：音声パケットがありません—このインタラクションでは音声を利用できません（音声パケットがありません）。 CXone Mpowerサポートに連絡してください。

  • 音声利用不可：外部ソースからの音声パケットなし：(CR機能)このインタラクションではオーディオは利用できません(メディアストリームに音声パケットがありません)。 CXone Mpowerサポートに連絡してください。

  • システムエラー：録音が開始されなかったか、その他の汎用エラーが発生しました。 CXone Mpowerサポートに連絡してください。

  • マスキング失敗：記録のマスキング失敗。 記録を再生して、機密データがあるかどうかを確認できます。 記録を削除するには、アクション アクションボタンのスクリーンショットをクリックして、記録の削除を選択します。

  • 録音はオンデマンドで停止した：記録はユーザーによって停止されました。

ポリシー名

録画ポリシーの名前、またはこのインタラクションに適用されたポリシーを記録しないでください。

フィールドタイプ：最大100文字(VARCHAR)の文字列
ANI

着信通話の場合、ANIは発信者の電話番号（発信元ID）です。

フィールドタイプ：最大200文字(VARCHAR)の文字列
DNIS

着信呼び出しの場合、DNISは呼び出された（番号がダイヤルされた）電話番号です。

フィールドタイプ：最大200文字(VARCHAR)の文字列
ACW（秒単位）

通話が終了した後、エージェントのアフターコールワークをキャプチャするために画面録画が継続した秒数。
ディスポジション エージェントが割り当てるタグに、通話に関する追加情報を付けます。

外部セグメントID

録音の外部ソースで定義されているセグメントのID。 値はAppLinkを持つユーザーのみが利用可能です

フィールドタイプ：最大100文字(VARCHAR)の文字列

APIバージョン: 6以上

外部コンタクトID

録音の外部ソースで定義されているコンタクトのID。 値はAppLinkを持つユーザーのみが利用可能です

フィールドタイプ：最大100文字(VARCHAR)の文字列

APIバージョン: 6以上

ソース

録音CXone Mpowerまたは外部ソースのソース。 値には以下が含まれます：

  • Engage

  • BrandEmbassy

  • Uptivity

  • InContactACD

  • マルチACD

  • MigratedCallsExternal

  • MigratedCallsEngage

  • MigratedCallsNim

  • SmartReach

フィールドタイプ：最大30文字(VARCHAR)の文字列

APIバージョン: 6以上

関連付けられたコンタクト番号リスト

セグメントに関連付けられたエージェントのコンタクト番号のリスト。 このリストの要素は、数値型のみです。

フィールドタイプ：バリアント

APIバージョン: 7以上

インタラクションID

インタラクションに対する一意のID (UUID)。 1つのインタラクションに複数のセグメントが関連付けられている場合、これらのセグメントのインタラクションIDは同じである場合があります。 インタラクションIDは、セグメントIDやコンタクトIDと同じではありません。

フィールドタイプ：最大36文字(VARCHAR)の文字列

APIバージョン: 7以上
保留数 コール中にエージェントが顧客を保留にした回数。

APIバージョン:8以降
保留時間(秒単位) 通話中に顧客が保留された合計秒数(すべての保留の合計)。

APIバージョン:8以降

複雑な通話

通話に複数の参加者がいたかどうかを示します。

フィールドタイプ:TRUEまたはFALSE(BOOLEAN)で構成されるブール値

APIバージョン:9以降

音声録音のマスキングステータス

インタラクションの音声録音マスキングのステータスを示します。

フィールドタイプ:文字列

APIバージョン:10以降

可能な値は次のとおりです。

  • 成功: 音声録音マスクに成功しました

  • 失敗:音声録音マスキングに失敗しました

  • 部分的:音声録音部分的にマスクされていました

  • NA:該当なし

画面録画マスキングステータス

インタラクションの画面録画マスキングのステータスを示します。

フィールドタイプ:文字列

APIバージョン:10以降

可能な値は次のとおりです。

  • 成功:画面録画が正常にマスクされました

  • 失敗:画面録画のマスキングに失敗しました

  • 部分的:画面録画が部分的にマスクされていました

  • NA:該当なし
エージェントユーザーID

エージェントに割り当てられた一意の識別子。

CSVファイルには、このフィールドがエージェントごとに個別の列として含まれており、最大5つのエージェントをサポートします。

例列名:Agent 1 User ID, Agent 2 User ID, ..., Agent 5 User ID

フィールドタイプ：最大36文字(VARCHAR)の文字列
エージェントACDID

ACDによってエージェントに割り当てられた一意の識別子。

CSVファイルには、このフィールドがエージェントごとに個別の列として含まれており、最大5つのエージェントをサポートします。

例列名:Agent 1 ACD ID, Agent 2 ACD ID, ..., Agent 5 ACD ID

フィールドタイプ：最大50文字(VARCHAR)の文字列
エージェントコンタクト番号

このエージェントに対して作成されたコンタクトの一意の識別子。

このフィールドはMulti-ACD (Open)では使用できません。

CSVファイルには、このフィールドがエージェントごとに個別の列として含まれており、最大5つのエージェントをサポートします。

例列名:Agent 1 Contact Number, Agent 2 Contact Number, ..., Agent 5 Contact Number

フィールドタイプ: 最大38桁を含む数値

APIバージョン: 5以上

エージェント名

CXone Mpower従業員アカウントで指定されたエージェントの名前。

CSVファイルには、このフィールドがエージェントごとに個別の列として含まれており、最大5つのエージェントをサポートします。

例列名:Agent 1 Name, Agent 2 Name, ..., Agent 5 Name

フィールドタイプ：最大100文字(VARCHAR)の文字列

エージェントチームID

エージェントのチームに割り当てられた一意の識別子。

CSVファイルには、このフィールドがエージェントごとに個別の列として含まれており、最大5つのエージェントをサポートします。

例列名:Agent 1 Team ID, Agent 2 Team ID, ..., Agent 5 Team ID

フィールドタイプ: 最大36文字(VARCHAR UUID)の文字列

エージェントチーム

エージェントのチーム名。

CSVファイルには、このフィールドがエージェントごとに個別の列として含まれており、最大5つのエージェントをサポートします。

例列名:Agent 1 Team, Agent 2 Team, ..., Agent 5 Team

フィールドタイプ：最大40文字(VARCHAR)の文字列

エージェントスキル

能力、専門分野、および知識に基づいて、ACDでエージェントに割り当てられた分類。

CSVファイルには、このフィールドがエージェントごとに個別の列として含まれており、最大5つのエージェントをサポートします。

例列名:Agent 1 Skills, Agent 2 Skills, ..., Agent 5 Skills

フィールドタイプ：最大50文字(VARCHAR)の文字列

ビジネスデータ名

指定されたビジネスデータフィールドの名前。

CSV ファイルには、このフィールドがビジネスデータエントリごとに個別の列として含まれています。

  • APIバージョン 7 から 10 の場合、ファイルは 最大 50 個のエントリ をサポートします: 35 個の varchar、10 個の数値、および 5 個のブール値

  • API制御リリース (CR) プログラムのお客様が利用できるバージョン 11 では、ファイルは 最大 250 エントリ をサポートします: 1 から 35 の varchar、36 から 45 の数値、46 から 65 のブール値、66 から 95 の日付、96 から 210 の varchar、211 から 250 の数値

例列名:Business Data Name 1, Business Data Name 2, ..., Business Data Name 50(CRの場合は最大Business Data Name 250)

フィールドタイプ：最大128文字(VARCHAR)の文字列

APIバージョン: 7以上

ビジネスデータ値

ビジネスデータ値は、テキスト、数値、または正誤です。

CSV ファイルには、このフィールドがビジネスデータエントリごとに個別の列として含まれています。

  • APIバージョン 7 から 10 の場合、ファイルは 最大 50 個のエントリ をサポートします: 35 個の varchar、10 個の数値、および 5 個のブール値

  • API制御リリース (CR) プログラムのお客様が利用できるバージョン 11 では、ファイルは 最大 250 エントリ をサポートします: 1 から 35 の varchar、36 から 45 の数値、46 から 65 のブール値、66 から 95 の日付、96 から 210 の varchar、211 から 250 の数値

例列名:Business Data Value 1, Business Data Value 2, ..., Business Data Value 50(CRの場合は最大Business Data Value 250)

フィールドタイプ：

  • 最大4000文字の文字列(VARCHAR)

  • 最大38桁の数値(NUMBER)

  • TRUEまたはFALSEで構成されるブール値(BOOLEAN)

  • サポートされている形式(DATE)の日付値

APIバージョン: 7以上

インタラクションが作成されてから2日以上経過経過したビジネスデータの更新は、データ抽出API出力には含まれません。

WFM給与エンティティとCSVファイル

WFM給与API（バージョン1）を使用すると、外部の給与レポートの目的でWFMアクティビティデータを抽出できます。

POSTジョブのWFM給与エンティティ名はwfm-payrollです。

データは、給与コードの日付に従ってフィルタリングされます。 日時のタイムゾーンは、スケジューリングユニットのタイムゾーンに従っていることに注意してください。

列名

説明

名

エージェントの名。

フィールドタイプ：最大255文字(VARCHAR)の文字列

姓

エージェントの姓。

フィールドタイプ：最大255文字(VARCHAR)の文字列

ユーザー名

エージェントのユーザー名。

フィールドタイプ：最大255文字(VARCHAR)の文字列

スケジューリングユニット

エージェントのスケジューリングユニット。

フィールドタイプ：最大256文字(VARCHAR)の文字列

スケジューリングユニットのタイムゾーン

エージェントのスケジューリングユニットのタイムゾーン。

フィールドタイプ：最大128文字(VARCHAR)の文字列

給与コード

予定アクティビティデータを含む給与コード。

フィールドタイプ：最大50文字(VARCHAR)の文字列

日付

アクティビティの日付（スケジューリングユニットのタイムゾーン内）。

フィールドタイプ：DATE

開始時刻

アクティビティの開始時刻（スケジューリングユニットのタイムゾーン）。

フィールドタイプ：TIME (9)

秒単位の期間

アクティビティの継続時間（秒単位）。

フィールドタイプ：NUMBER (8.0)