業務資料 API
業務資料是可以與通話的中繼資料相關聯的自訂欄位。 利用業務資料 API,您可以為任何已結束的互動更新現有業務資料欄位的值。 您無法使用此 API 新增新的業務資料欄位。 此 API 可與 Studio 中的MCR META DATA動作同時使用。 此動作可讓您在即時互動期間傳送單個連絡人的互動資料。
業務資料API的文件可在開發人員社群入口網站
中找到。
開始之前
您可以在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 - 內部伺服器錯誤。