Mobile SDK

當前版本:2.2(與 24.4 版CXone Mpower 發布相關)
API 參考

為了幫助您開始實作行動 SDK,您必須從NICE購買基本實作套件。 NICE的合作夥伴將引導您完成實施。

Mobile SDK允許您將CXone Mpower 數位聊天整合到您的企業行動手機應用程式中。 這使得應用程式使用者可以透過數位Closed 任何與Digital Experience相關的通道、聯絡或技能。聊天通道與您的聯絡中心客服專員和機器人聊天。 SDK 簡化了實現數位聊天的過程;開發人員不需要處理業務邏輯的實作。 開發人員的主要任務是直觀地顯示和管理您在CXone Mpower中設定的功能,例如推送通知或富訊息。 SDK 支援iOSAndroid應用程式iOS應用程式 必須寫為 Swift在新視窗中打開此連結 ,而Android應用程式必須用 Kotlin在新視窗中打開此連結

透過 Mobile SDK

要快速了解 SDK 的優勢,您可以查看Mobile SDK資料表在新視窗中打開此連結。 您也可以觀看簡短示範影片在新視窗中打開此連結

SDK 資源

從公共GitHub存放庫下載 SDK 套件 (Android在新視窗中打開此連結iOS在新視窗中打開此連結)。 兩個存放庫都包含一個 README 文件,可協助您開始開發工作。 他們還在/docs中提供帶有代碼範例的用例。 在開發聊天時可以使用這些作為靈感。 這兩個存放庫還包含變更記錄。

您可以在瀏覽器中存取 API 參考 (Android在新視窗中打開此連結iOS在新視窗中打開此連結)。

您的開發人員也可以查看Android 在新視窗中打開此連結iOS 在新視窗中打開此連結 平台應用程式 範例。 它們可以幫助開發人員查看已實現的功能範例。

Mobile SDK 版本

SDK 版本通常與CXone Mpower 主要行銷發布(如 25.2、25.3 等)一起更新。 在GitHub 中,每個發布版本根據下文解釋的語義版本控制進行標記。

NICE 支援 SDK 的當前和以前的主要版本。 例如,如果當前版本是 2.2,NICE 支援 v2.2 和 1.3(最新的 1.xx 版本)。

隨著 SDK 的更新,您有責任確保應用程式 處於最新狀態。 上面的 SDK 資源部分提供了最新資源的連結。 在 SDK 存放庫中,您可以使用標記來尋找先前版本的 SDK。 另請注意,SDK 向後兼容最近的兩個主要版本。

版本變更

當 SDK 版本因發布而變更時,版本號表示變更的類型。 以下是對該外延的解釋:

  • 2.0.0:第一個數字表示主要的 API 變更。

  • 2.1。0:第二個數字表示非中斷變更。 通常,新功能作為非中斷性變更被新增。

  • 2.0.1:第三個數字表示錯誤修復。 這些始終向後兼容。

錯誤修復

NICE 專業服務與您合作修復錯誤。 您可以透過他們(或實作合作夥伴)提交錯誤,然後他們會與您交流,除了 SDK 變更日誌之外,還與您進行了修正。

此外,目前支援的版本中的任何錯誤都已修復。 例如,如果當前版本是 3.0,則兩個支援的版本是 3.0 和 2.3(2.x 以來的最新版本)。 如果您在 v2.1 中發現錯誤,NICE 會在 2.3 和 3.0 中修復,但在 2.1 或 2.2 中不會。

Mobile SDK 如何與Digital Experience相容

行動 SDK 是一種擴展Digital Experience 並在行動中提供數位 聊天的方法應用程式Digital ExperienceCXone Mpower中支援數位通道的部分。 數位通道的範例包括WhatsAppFacebook上的帖文或數位聊天。 要新增CXone Mpower數位聊天到您的應用程式,您必須在介面的部分配置某些Digital Experience功能CXone Mpower。 然後,透過 SDK,您可以存取和使用在CXone Mpower中設定的功能。

例如,入門過程的一部分是在CXone Mpower中設定數位聊天通道。 然後,您的應用程式 必須與您建立的數位聊天通道建立WebSocket 連接。 您也可以設定進階功能,如歡迎訊息或聊天前調查。 這些為您提供了多種選項來簡化應用程式使用者體驗。 使用者可以提供有關其問題或請求的初始資訊、輸入基本個人資料等。 這些功能最初在CXone Mpower中設定,然後您可以將其與 SDK 一起使用。

Mobile SDK 基礎結構圖

構建您的聊天 UI

作為整合者,您負責構建聊天 UI。 這是利用某些功能(如顯示和處理檔案或錄製語音訊息)所必需的。 例如,您需要新增一個按鈕供聯絡人按下以存取裝置的麥克風來錄製訊息。 您可以參考範例應用程式(Android在新視窗中打開此連結iOS在新視窗中打開此連結)了解如何實現 UI 的範例。

您可以使用第三方 UI 開發套件,例如 MessageKit。 但是,這可能會受到限制,具體取決於您的用例。 此外,CXone Mpower不擁有任何第三方 UI 包,也不提供對任何第三方 UI 包的支援。

開始開發前

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

  • 您在 CXone Mpower 中同時擁有管理員和客服專員帳號嗎? 管理員可以協助您在 CXone Mpower平台 中設定必要的功能嗎?
  • 您的手機應用程式可用於iOS(Apple)、Android或兩者? 您的開發人員熟悉 Swift 和 Kotlin 語言嗎?
  • 您有現有的聊天訊息通道,還是想建立一個新通道?
  • 您會使用OAuth來驗證您的應用程式使用者嗎? 若是,您將使用哪個 OAuth 供應商?
  • 您想提供單執行緒或多執行緒的對話嗎?
  • 您會使用主動動作,例如彈出視窗或歡迎訊息嗎?
  • 您想使用推送通知嗎? 您是否有現有的 Firebase 或Apple開發者帳戶?
  • 您想要設定哪些類型的富訊息? 您可以在哪些用例中利用這些互動訊息?
  • 您想追蹤使用者資料嗎? 如何使用訪客事件進行分析?

關鍵術語

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

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

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

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

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

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

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

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

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

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

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