データ抽出API

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

データ抽出APIは、DEVone開発者コミュニティポータルで入手できます。

ドメインとURLの詳細については、DEVone DeveloperCommunityポータルの はじめに」を参照してください。

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

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

始める前に

ビジネスデータAPIの使用を開始する前に、ユーザー権限を設定し、アクセスキーを生成して、開発者ポータルで説明されている登録および認証プロセスに従う必要があります。必要な権限:

  • エンティティ:

GET ジョブ

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

POSTジョブ

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

GETジョブID別のジョブ

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

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

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

POSTジョブの場合:

  • entityNameは:qm-workflows

  • バージョン4

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

CXone QM質問と回答(Q&A)エンティティとCSVファイル

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

POSTジョブの場合:

  • entityNameは:qm-questions

  • バージョンは:2です

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

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

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

POSTジョブの場合:

  • entityName qm-evaluation-comment-entity

  • バージョン1

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

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

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

POSTジョブの場合:

  • entityNameは:recording-interaction-metadata

  • バージョン7

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

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

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

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

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