CXone Agent SDK

SDK 語言：Typescript

目前版本：24。3

當前版本的發佈日期：2024 年 10 月 15 日

可用性：所有地區、所有業務分段

瀏覽器支援：GoogleChrome、MicrosoftEdge、Island Enterprise

SDK 存放庫：GitHub。

CXone AgentSDK 允許您構建客服專員應用程式。它還允許您將CXone Agent功能整合到現有的應用程式中。開發人員可以透過 SDK 使用預製功能，而不是直接使用CXoneAPI。這可以縮短開發時間並節省資源。您的開發人員不需要了解所有CXoneAPI 的工作原理。相反，SDK 允許您在可使用的 JavaScript 包裝器中使用 API 組。

CXASDK 是較小 SDK 的編譯。每個較小的 SDK 都專注於功能的特定方面，例如驗證或通話控制。為了滿足您的用例，您可以只選擇您需要的 SDK。例如，您可能不需要為整合式軟體電話提供WebRTC功能的 Voice SDK。這也表示開發人員只需為您的用例安裝必要的 SDK。

關於 CXASDK 的重要資訊：

SDK 透過事件訂閱來運作。來自CXone平台的資料隨事件一起發布。要使用資料，您的應用程式必須訂閱這些事件。
CXone Agent的所有功能均可透過此 SDK 獲取。
您必須註冊將使用 SDK 的應用程式。完成註冊表單將接收此應用程式的認證。入門開發者入口網頁將引導您完成註冊應用程式和設定驗證的過程。
SDK 支援OpenID Connect的 PKCE 驗證流程。

CXASDK 用例

以下是CXASDK 的三個常見用例。

自訂客服專員用戶端:
在這種情況下，您擁有本機CXone Agent尚未提供的獨特功能或要求。另外，也許您不能簡單地將所需的功能嵌入到CXone Agent中。例如，您可能需要限制客服專員對聯絡人資訊的可見性。這可能是出於滿足特定的安全要求。您可能需要遮罩客服專員的所有聯絡資料，只有自訂用戶端才能做到這一點。
將客服專員用戶端與第三方應用程式整合：
在這種情況下，您不能將客服專員應用程式嵌入到另一個應用程式中。其他應用程式通常是 CRM、線上銀行網站或酒店預訂系統。此用例用在您需要客服專員用戶端的功能，但不一定需要用戶端 UI 時。使用 SDK，您可以將一項功能構建到另一個應用程式中。以酒店系統為例，工作人員可以透過預訂系統調用特定的房間。
嵌入式應用程式的事件訂閱：
這通常用於遵守某些瀏覽器的安全限制。例如，Google可防止將資料從其他網站發布到 iframe 視窗。這使得視窗在兩個框架之間分享訊息或資料變得複雜。例如，您有一個醫療保健應用程式，您將其發布 iframe CXone Agent中。當客服專員接聽聯絡人時，您希望使用聯絡人的電話號碼在您的醫療保健應用程式中找到他們的資訊。這使您可以自動向客服專員顯示聯絡人資訊。如果客服專員使用GoogleChrome，則醫療保健應用程式無法從CXone Agent獲取聯絡人電話號碼。相反，它需要訂閱 VC 事件流，這與CXone Agent使用的相同。

SDK 細分

CXASDK 由以下較小的 SDK 組成：

SDK	詳細資訊
ACD	此 SDK 提供處理語音通話、語音郵件和工作項目透過 Studio 指令碼向客服專員傳遞聯絡人的可自訂方法。的功能。範例：對於語音呼叫，您可以發起、接聽、轉接和召開電話會議。對於語音郵件，您可以接收、存儲和管理語音郵件。對於工作項目，您可以自動將工作項目指派給客服專員。這可以使用預先定義的規則和標準來最佳化客服專員的工作量。檢視技術詳情以下是有關ACDSDK 的關鍵技術詳情：驗證成功後，您可以呼叫initAcdEngagement()實例化該模組並構建ACD功能。您可以使用startSession和joinSession方法在客服專員和聯絡人之間建立會話。會話建立後，您的應用程式可以調用其他方法來實現撥號、轉接、召開多方會議等功能。成功調用此模組的方法會產生ACD事件。
客服專員	此 SDK 用於處理會話事件。它允許您啟動會話、加入正在進行的會話等等。其重點在於：獲取下一個事件循環 Digital ExperienceCXone的ACD和平台區域的任何內容都有其共同點，例如WEM或通知。
Auth	該 SDK 有助於安全驗證和授權。它主要允許您使用CXone全域驗證設定登入流程。支援的驗證流程是使用 PKCE 的OpenID Connect。使用者必須使用CXone帳戶進行驗證。這使您可以根據CXone角色搜尋線索來識別客戶的失望情緒。這些線索包括像「我很生氣」這樣的詞和短語。失望並不等同於負面情緒。失望線索顯示客戶不高興，而不僅僅是討論負面的東西。驗證使用者身分及其權限。主要功能包括：自動刷新auth權杖。這讓使用者保持登入狀態，直到關閉應用程式或登出。權杖管理和驗證。如果使用者已登入CXone，您可以將有效的auth權杖傳遞給您的應用程式。檢視技術詳情以下是有關 Auth SDK 的關鍵技術詳情：調用cxoneAuth.init()將cxoneHostname、clientId和redirectUri傳遞到 SDK。叫用getAuthorizeUrl()方法將使用者重新導向到全域CXone驗證頁面。登入後，它們會重新導向回您的應用程式。當使用者輸入認證並啟動驗證時，將使用其使用者資訊建立AuthSettings物件。 CXoneAuth實例使用AuthSettings進行初始化。使用getAccessTokebByCode()擷取傳回的代碼並產生驗證權杖。這也儲存了使用者的資訊。訂閱onAuthStatusChange，它會產生有關驗證的事件，例如AUTHENTICATED或AUTHENTICATEDFAILED。對於AUTHENTICATED，這會自動觸發刷新流程，保持使用者登入狀態。
數位	此 SDK 可讓您整合數位通訊通道。您可以使用電郵、聊天和簡訊，以及WhatsApp社交媒體平台等標準數位通道。根據您設定的通道數量，您可以建立多通道通訊。檢視技術詳情以下是有關 Digital SDK 的關鍵技術詳情：驗證成功後，可調用CXoneDigitalClient.instance.initDigitalEngagement()。這會實例化數位訊息傳遞所需的元件，並建立數位WebSocket連接。使用數位事件接收已指派的個案及其現有訊息執行緒。您的應用程式可以使用reply()方法回覆數位訊息。您也可以使用reply()方法發起新的傳出互動。
語音	此 SDK 為您提供整合式軟體電話功能。它是WebRTC的包裝器。

資源

SDK 可讓您建立自己的自訂功能，使您的支援資源主要為自助服務內容。您的技術支援選項是基於您的組織與NICE的支援協定。請聯絡您的CXone 客戶代表，了解更多有關支援選項的資訊。

除了此頁面之外，您的自助服務內容還重點關注開發人員資源。 SDK 套件包含以下內容：

每個單獨 SDK 的 README 檔案提供入門資訊。
範例應用程式展示基本功能。
使用範例以及範例應用程式中的代碼摘錄。
代碼備註。

事件

以下是您的應用程式可以監聽的事件。事件按其可用的模組進行分類。

ACD SDK

檢視事件

實例	事件	描述
CXoneAcdClient.instance.contactManager	conferenceCallEvent	監聽與多方通話相關的事件。
	onDispositionEvent	處理與互動的處置方式客服專員或系統在語音（處置方式）或數位（狀態）互動結束時指派的結果。相關的事件。
	onTagsEvent	管理與互動關聯的標記相關的事件。
	voiceContactUpdateEvent	監聽語音聯絡的更新。
	voiceMailContactUpdateEvent	監聽語音郵件聯絡的更新。
	workItemContactUpdateEvent	監聽工作項目聯絡的更新。
CXoneAcdClient.instance.notification	onUpdateMessageEvent	監聽客服專員的新訊息或通知。
CXoneAcdClient.instance.screenPop	agentAssistSubject	處理與客服專員助理或 copilot 應用程式相關的事件。
	contactScreenPopSubject	處理與傳入聯絡人的螢幕彈出相關的事件。
	pageOpenSubject	處理與開啟網頁相關的事件。
	popUrlSubject	處理與在新視窗或標籤中彈出 URL 相關的事件。
	runAppSubject	處理與執行應用程式或開啟自訂表單相關的事件。
CXoneAcdClient.instance.session	agentLegEvent	監聽會話中與客服專員的分支發生在CXone和客服專員之間的互動部分。相關的事件。
	agentStateSubject	「可觀察」發出與客服專員狀態變化相關的事件，例如「可用」到「不可用」。
	naturalCallingSkillListSubject	監聽自然調用啟用的技能清單的更新。事件類型包括：SESSION_START、SESSION_END、JOIN_SESSION_SUCCESS 和 JOIN_SESSION_FAILURE。
	networkOfflineSubject	監聽與網路連接問題相關的事件。
	onAgentSessionChange	監聽客服專員會話狀態（例如開始或結束）的變更。事件類型包括：SESSION_START、SESSION_END、JOIN_SESSION_SUCCESS 和 JOIN_SESSION_FAILURE。
CXoneAcdClient.instance.session.agentStateService	agentStateSubject	「可觀察」發出有關客服專員狀態變更的更新。

Agent SDK

檢視事件

實例	事件	描述
CXoneClient.instance	autoSummaryService	用於管理自動摘要的服務。
	copilotNotificationClient	有助於 Agent Copilot 接收即時通知。
	cxoneApiPerformanceMetrics	監聽來自 CXoneAPI 的表現指標。
CXoneClient.instance.agentSession	agentSessionEndSubject	當前客服專員的會話結束時發出事件。
CXoneClient.instance.agentSetting	mchAgentSettingsChangeEvent	監聽客服專員的「接聽通話」(MCH) 設定中的變更。
CXoneClient.instance.autoSummaryService	onAutoSummaryReceived	當收到聯絡人自動產生的摘要時，會觸發可觀察事件。
CXoneClient.instance.commitment	onCommitmentEvent	監聽與客服專員承諾相關的事件。
	onCommitmentStatusEvent	監聽客服專員承諾狀態的變化。
	onUpdateCommitments	監聽客服專員承諾的更新。
CXoneClient.instance.contactManager	onDigitalContactEvent	提供CXone中的數位聯絡人互動的更新，例如聊天會話和傳出訊息。
	onDispositionEvent	呼叫結束後提供呼叫處理狀態的更新。
	voiceContactUpdateEvent	提供正在進行的語音通話詳細資訊（例如來電者姓名和電話號碼）的即時更新。
CXoneClient.instance.copilotNotificationClient	onMessageNotification	可觀察/事件發送器用於訂閱傳入的 copilot 訊息或通知。事件類型包括：ADAPTIVE_CARD, RT_SUMMARY、NEXT_BEST_RESPONSE、NEXT_BEST_RESPONSE_LLM、NEXT_BEST_RESPONSE_EXPERT, KB_ANSWERS, SENTIMENT、KB_LINKS、KB_IMAGES、TEXT、FINAL_SUMMARY、FINAL_SUMMARY_NOTES、KB_ANSWERS_VOICE、KB_IMAGES_VOICE、ENLIGHTEN_AGENT_COPILOT 和 AGENT_COPILOT。
CXoneClient.instance.directory	directoryEvent	監聽與目錄相關的事件，例如客服專員、團隊或技能。提供目錄資料變更的更新，例如 CXone 中的新聯絡、更新和權限修改。
	onUpdateSkillsEvent	監聽客服專員指派的技能的更新。
CXoneClient.instance.directory.dynamicDirectory	searchDirectoryResult	在系統內的目錄中尋找諸如人員或部門之類的內容後，等待結果返回。
CXoneClient.instance.indicator	agentIndicatorsEvent	提供客服專員指標更新的事件，例如可用性、目前活動和自訂客服專員狀態指標。
	contactIndicatorsEvent	提供聯絡人指標更新的事件，可能會觸發顯示自訂表單以收集其他資訊等動作。
CXoneClient.instance.notification	onCXoneNotificationEvent	監聽來自CXone平台的通知。
CXoneClient.instance.screenPop	contactScreenPopSubject	觸發開啟包含現有通話呼叫者資訊網頁的事件。
	pageOpenSubject	觸發開啟不一定與目前通話相關的網頁的事件。
	popUrlSubject	觸發開啟現有呼叫的相關網頁的事件。
	runAppSubject	觸發啟動應用程式或顯示呼叫自訂表單的事件。
CXoneClient.instance.session	agentLegEvent	監聽客服專員特定通話分支的更新，例如傳入或傳出通話。
CXoneClient.instance.session.agentStateService	agentStateSubject	提供CXone中有關客服專員可用性狀態和狀態變更的即時更新的事件。
CXoneClient.instance.skillActivityQueue	agentQueueSubject	提供有關客服專員指派的佇列資訊（例如佇列名稱、呼叫數和客服專員可用性）的更新的事件。
	agentQueuesDetailSubject	提供有關客服專員指派的佇列的詳細更新的事件，包括平均等待時間、服務等級協定 (SLA) 和客服專員表現等指標。
	skillActivityEvent	提供技能活動指標（例如呼叫佇列長度、平均等待時間和可用客服專員）更新的事件。

Auth SDK

檢視事件

實例	事件	描述
CXoneAuth.instance	onAuthStatusChange	「可觀察」監聽使用者驗證狀態的變化。事件類型包括：AUTHENTICATED、AUTHENTICATING、NOT_AUTHENTICATED、AUTHENTICATION_FAILED 和 REFRESH_TOKEN_SUCCESS

實例

事件

描述

CXoneAuth.instance

onAuthStatusChange

「可觀察」監聽使用者驗證狀態的變化。

事件類型包括：AUTHENTICATED、AUTHENTICATING、NOT_AUTHENTICATED、AUTHENTICATION_FAILED 和 REFRESH_TOKEN_SUCCESS

Digital SDK

檢視事件

實例	事件	描述
CXoneDigitalClient.instance.digitalContactManager	onDigitalContactEvent	監聽與數位聯絡人相關的事件。事件類型包括：CASE_INBOX_ASSIGNEE_CHANGED、CASE_STATUS_CHANGED、MESSAGE_ADDED_INTO_CASE、CASE_INBOX_ASSIGNED、CASE_INBOX_UNASSIGNED、MESSAGE_CREATED、MESSAGE_NOTE_CREATED、MESSAGE_NOTE_DELETED、MESSAGE_NOTE_UPDATED、MESSAGE_UPDATED、SENDER_TYPING_START、SENDER_TYPING_END 和 MESSAGE_PREVIEW。
	onDigitalContactNewMessageEvent	監聽來自數位聯絡人的新訊息。
	onDigitalContactUserTypingPreviewEvent	監聽來自數位聯絡人的鍵入預覽事件。事件類型包括：CASE_INBOX_ASSIGNEE_CHANGED、CASE_STATUS_CHANGED、MESSAGE_ADDED_INTO_CASE、CASE_INBOX_ASSIGNED、CASE_INBOX_UNASSIGNED、MESSAGE_CREATED、MESSAGE_NOTE_CREATED、MESSAGE_NOTE_DELETED、MESSAGE_NOTE_UPDATED、MESSAGE_UPDATED、SENDER_TYPING_START、SENDER_TYPING_END 和 MESSAGE_PREVIEW。

實例

事件

描述

CXoneDigitalClient.instance.digitalContactManager

onDigitalContactEvent

監聽與數位聯絡人相關的事件。

事件類型包括：CASE_INBOX_ASSIGNEE_CHANGED、CASE_STATUS_CHANGED、MESSAGE_ADDED_INTO_CASE、CASE_INBOX_ASSIGNED、CASE_INBOX_UNASSIGNED、MESSAGE_CREATED、MESSAGE_NOTE_CREATED、MESSAGE_NOTE_DELETED、MESSAGE_NOTE_UPDATED、MESSAGE_UPDATED、SENDER_TYPING_START、SENDER_TYPING_END 和 MESSAGE_PREVIEW。

onDigitalContactNewMessageEvent

監聽來自數位聯絡人的新訊息。

onDigitalContactUserTypingPreviewEvent

監聽來自數位聯絡人的鍵入預覽事件。

Voice SDK

檢視事件

實例	事件	描述
CXoneVoiceClientWrapper.instance	onCallStatusChanged	處理與呼叫狀態變更相關的事件。
	onConnectionStatusChanged	處理與語音連接狀態變更相關的事件。