數位Chat Web SDK

SDKGitHub

API 參考GitHub頁面

範例應用程式GitHub

NPM 套件npmjs.com

Chat Web SDK 可讓您建立自己的 數位 聊天 應用程式,或將 數位聊天新增至現有 Web 應用程式 中。此工具套件允許您在您選擇的 UI 中使用 CXone 數位基礎結構。這是一個基於 JavaScript 的 SDK,支援 LiveChatChat Messaging—同步和非同步訊息傳遞。您也可以設定Closed 在單執行緒應用程式中,每位聯絡人都只能有一個聊天執行緒。聯絡人與貴組織的任何互動都將在該聊天執行緒中進行。多執行緒Closed 在多執行緒應用程式中,聯絡人可以根據需要建立多個執行緒來討論新主題。這些執行緒可同時執行。訊息傳遞。此 SDK 讓您可以更好的控制網站上的CXone。它可以幫助您避免某些網站的特定技術限制。例如,您的網站可能不允許使用外部代碼,這可能會妨礙本地CXone 數位聊天的執行。

該 SDK 支援以下功能:

  • 數位聊天訊息傳遞
  • OAuth2.0 授權協定
  • 聯絡人識別和自訂欄位
  • 執行緒清單和執行緒恢復
  • 附件
  • 富訊息
  • 輸入、檢視訊息和傳遞訊息的指示器
  • 系統訊息,例如案例狀態事件或指派事件
  • 佇列位置事件

該 SDK 使用 TypeScript 4.9+ 編寫。您還必須使用自訂 應用程式 bundler like webpack or Create React App

SDK 資源

此頁面頂部或下面的下拉式選單提供了各種 SDK 資源的連結。

您的開發人員可以從 GitHub 獲取 SDK。該儲存庫有一個 README,此讀我檔案可以幫助開發人員入門。其中還包含事件的文件和 API 參考。更方便使用的 API 參考透過 github.io 單獨託管。

您也可以查看樣本 應用程式。這可以讓您嘗試聊天並查看相關的原始程式碼。

開發人員將 SDK 作為 NPM 套件匯入。npmjs.com 上的套件條目包含所有相同的內容以及使用 SDK 設定和建置的說明。

關鍵術語

  • 執行緒:聊天應用程式中的對話。由客服專員或聯絡人Closed 在聯絡中心與客服專員、IVR 或機器人互動的人。傳送的第一個訊息開始一個執行緒。對話中的每個連續訊息都會新增到執行緒中。執行緒是包含每個訊息的物件。訊息由訊息作者建構。threadId標識整個對話,對話中的所有訊息都有一個訊息 ID。對話結束時,執行緒也會結束。

  • 單執行緒:一種應用程式設計,其中聯絡人一次只能進行一個對話。

  • 多執行緒:一種應用程式設計,其中聯絡人可以一次進行多個對話。

  • 通道:在Digital Experience的環境中,通道是指訊息傳遞類型或用於通訊的平台。例如,您可以有一個WhatsApp即時訊息通道。行動 SDK 可讓您在行動應用程式上新增聊天訊息通道。在CXone平台中建立通道。這決定了通道的設定以及通道 ID。當應用程式使用者打開聊天時,您可以使用此 ID 啟動聊天通道。

  • ChannelId:在CXone數位部分中建立的數位聊天通道的 ID。您可以在CXone(ACD>數位>數位聯絡點>聊天>初始化和測試)中的聊天通道設定中找到此編號。

  • BrandId:這類似於Digital Experience租戶Closed 用於管理 CXone 環境的技術支援、計費和全域設定的高級組織分組 ID。其用於初始化聊天。您可以在CXone(ACD>數位>數位聯絡點>聊天>初始化和測試)中的聊天通道設定中找到此編號。

  • CustomerId:聊天最終使用者的唯一 ID。SDK 在聊天初始化時建立此 ID。如果您設定了OAuth,則每個聯絡人在其所有裝置上的此 ID 都保持不變。如果您沒有設定OAuth,則該 ID 對於每個裝置都不相同;ID 將變成訪客登入名稱。

  • 區域或環境:託管CXone部署的全球位置。這可以是:澳洲 (AU1)、加拿大 (CA1)、歐洲 (EU1)、日本 (JP1)、北美 (NA1) 或英國 (UK1)。開發者必須使用託管您的CXone系統的同一區域,否則聊天連接將被拒絕。

  • 聯絡人、客戶和使用者:這些術語均指行動應用程式的最終使用者。線上說明通常使用術語聯絡人。在 SDK 文件和代碼備註中,您可能會看到客戶使用者

  • CXone:核心平台,您可以在其中管理和存取NICE CXone提供的所有客戶體驗工具。根據您想要在行動應用程式中提供的聊天功能,擁有必要使用者帳號權限的管理員必須在CXone中完成多項設定任務。

  • Digital ExperienceCXone的部分,您可以在其中管理有關數位通道的所有內容。

開始開發前

在使用 mobile SDK 進行建置之前,請考慮以下事項:

  • 您在 CXone 中同時擁有管理員和客服專員帳號嗎?管理員可以協助您在 CXone平台 中設定必要的功能嗎?
  • 您是否有現有的聊天通道,還是想建立一個新通道?
  • 您想提供單執行緒或多執行緒的對話嗎?
  • 您想要設定哪些類型的富訊息?您可以在哪些用例中利用這些互動訊息?
  • 您會使用主動動作,例如彈出視窗或歡迎訊息嗎?