ビジネスデータAPI

ビジネスデータは、通話のメタデータに関連付けることができるカスタムフィールドです。ビジネスデータAPIを使用すると、閉じたインタラクションの既存のビジネスデータフィールドの値を更新できます。このAPIを使用して新しいビジネスデータフィールドを追加することはできません。このAPIは、StudioのMCR META DATAアクションと共に機能します。このアクションを使用すると、ライブインタラクション中にシングルコンタクトのインタラクションデータを送信できます。

ビジネスデータAPIのドキュメントは、Developer Communityポータルで入手できます。

始める前に

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

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

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

エンティティ：ビジネスデータAPIを更新するには、検索と再生>API>ビジネスデータの更新権限が必要です。

ビジネスデータを更新する

クローズされたインタラクションの場合は、指定されたACD contactIdで使用可能なすべてのセグメントの既存のビジネスデータフィールド情報を更新します。

メソッド:PUT

エンドポイント: /business-data-manager/v1/business-data/contact/{ACD contactId}

パラメーター:

contactId*：

文字列

ビジネスデータ値を更新するACD contactIdの一意の識別子。

値と応答の例

URL:https://na1.test.nice-incontact.com/business-data-manager/v1/business-data/contact/8675309

タイプ：PUT

[ { "business_data_name1": "string of text" }, { "business_data_name2": true, }, { "business_data_name3": 1234, } ]

応答

ステータス204 - サーバーはリクエストを正常に実行し、応答ペイロード本文に送信する追加コンテンツがないことを示します。
ステータス400 - リクエストに誤った入力パラメータが含まれています。
ステータス401-認証失敗。不正な資格情報。
ステータス403 - 権限が必要です。
ステータス404 - 要求されたコンタクトが見つかりませんでした。
ステータス500-内部サーバーエラー。

ビジネスデータを更新する

クローズされたインタラクションの場合は、指定されたACD contactIdで指定されたセグメントの既存のビジネスデータフィールド情報を更新します。

メソッド:PUT

エンドポイント: /business-data-manager/v1/business-data/contact/{ACD contactId}/segment/{segmentId}

パラメーター:

contactId*：

文字列

更新するビジネスデータ値を含むセグメントを含むACD contactIdの一意の識別子。

segmentId*:

文字列

更新するビジネスデータ値を持つACD contactIdセグメントの一意の識別子。

値と応答の例

URL: https://na1.test.nice-incontact.com/business-data-manager/v1/business-data/contact/{ACD contactId}/segment/b2e28d4e-ef22-4597-a104-2e740f729686

タイプ：PUT

[ { "business_data_name1": "string of text" }, { "business_data_name2": true, }, { "business_data_name3": 8675309, } ]

応答

ステータス204 - サーバーはリクエストを正常に実行し、応答ペイロード本文に送信する追加コンテンツがないことを示します。
ステータス400 - リクエストに誤った入力パラメータが含まれています。
ステータス401-認証失敗。不正な資格情報。
ステータス403 - 権限が必要です。
ステータス404 - 要求されたセグメントが見つかりませんでした。
ステータス500-内部サーバーエラー。