使用 JavaScript 自訂聊天通道

您可以使用 JavaScript自訂live chatClosed 座席與聯絡人以即時方式進行互動。和chat messagingClosed 非同步聊天,聯絡人可隨時傳送聊天訊息,並等候回覆。。NiCE CXone 提供預設自訂及其相應的 JavaScript API 呼叫。 您必須在將聊天新增到網站的指令碼標記中包含這些 API 調用。 要新增這些功能,您需要存取您網站的代碼。 本頁說明了新增JavaScript的位置以及需要包含的確切代碼行。 您還應熟悉 JavaScript 或 web 開發,以便自信地使用本頁面上的資訊。

您可以自訂聊天通道Closed 於聯絡中心內促進客戶互動的各種語音及數碼通訊媒介。的以下方面:

目前,所有 JavaScript 資料提取 API 均支援每次電話呼叫使用 Brand Embassy 載入器。 如果您在網站上使用獨立的 NiCE CXone 聊天,所有這些呼叫也支援新的NiCE CXone載入器。 最終,聊天的所有 JavaScript 資料提取 API 都將使用 NiCE CXone 載入器,而不是 Brand Embassy。

JavaScript 調用的結構會根據您使用的載入器而有所不同。 您不能同時使用這兩種結構。 僅使用其中之一種結構,具體取決於您使用的載入器。

如果您使用 NiCE CXone Guide 在您的網站上實現聊天功能,請使用 NiCE CXone 載入程式。並非本頁上的所有呼叫都在 Guide 中受支援,但Guide 文件列出了所有受支援的 JavaScript 呼叫。

如果您使用 NiCE CXone 載入器,無論是透過數位聊天還是 Guide,結構調用如下:

cxone('chat','enableChatAlwaysOnline');

如果您使用 Guide 來實作聊天,則必須同時以此方式建構預設啟動程式碼片段:

cxone('guide','init');

若您使用 Brand Embassy loader,請按以下方式構建呼叫(true/false 為可选):

brandembassy('enableChatAlwaysOnline',true);

新增 JavaScript 個通話至聊天通道

如果您還未進行此操作,請設定即時聊天或聊天訊息通道。 在新增自訂項之前測試通道以確保它使用預設設定。 在將聊天自訂發布到生產環境之前,在測試環境中設定聊天自訂項。 這將有助於最大限度地減少對網站存取者的干擾。 此外,它還有助於確保您的自訂項按預期工作。

完全按照所示步驟複製指令碼和 API 調用。 任何意外變更都可能導致您的通道出現故障。

  1. 按一下應用程式選擇器 icon of app selector 並選取 ACD。
  2. 前往 Digital > 聯絡點 Digital。

  3. 在「您的通道」下,點擊網站指令碼。
  4. 從頁面上複製 JavaScript 代碼並貼到 Notepad++ 等文字編輯程式中。 請務必加入開頭和結尾的 <script> 標記。
  5. 在 Notepad++ 中,在您貼上的程式碼之結尾 </script> 標籤正上方,加入您想使用的 JavaScript 呼叫。 在下列的範例圖像中,註釋指示了新增調用的位置。 本頁面的後續內容將介紹您可以使用的受支援調用。

  6. 將整個指令碼(包括開頭和結尾的 <script> 標記)複製並貼上到您網站頁面的標頭中。

  7. 造訪修改後的頁面並傳送測試聊天訊息,以確保您的自訂工作符合預期。

  8. 當其被完全測試並按預期工作時,將最終指令碼複製到應該會有聊天小工具的每個頁面的標頭中。

Chat 行為 JavaScript 通話

本節中的調用允許您變更聊天視窗的行為方式。

開啟聊天視窗

自動開啟聊天視窗。 預設行為是在聯絡人點擊聊天圖示時開啟聊天視窗。


cxone('chat', 'openChatWindow');

關閉聊天視窗

自動關閉一個聊天視窗。 預設行為是在聯絡人點擊聊天圖示時關閉聊天視窗。


cxone('chat', 'hideChatWindow');

以程式方式結束即時聊天會話

關閉 hideChatWindow 聊天視窗僅會將其從畫面中隱藏。工作階段會保持運作,並在聯絡人Closed 在您的聯絡中心內與客服專員、IVR 或機械人互動的人員。再次開啟聊天或重新載入頁面時繼續進行。

當您的網站需要自行結束會話時,請改用endContact。例如,當聯絡人登出您的網站,或導覽至不再需要聊天的頁面時。endContact電話會以聯絡人在聊天視窗中按一下End chat相同的方式結束使用中的互動。聊天會話結束後,即使聯絡人重新載入該頁面,聊天視窗也不會重新加入該會話。下一個聊天會話僅會在聯絡人或您的網站啟動會話時開始,例如使用autoStartSession。

關閉作業會透過 CaseStatusChanged 推送更新以非同步方式確認,您可以使用 onPushUpdate 訂閱該更新。當互動已關閉時,該事件的 data.case.status 即為已關閉:


cxone('chat', 'onPushUpdate', ['CaseStatusChanged'], (event) => {
  if (event.data.case.status === 'closed' {
	//the interaction has ended
	}
  });

此通話僅適用於即時聊天Closed 座席與聯絡人以即時方式進行互動。。在聊天訊息Closed 非同步聊天,聯絡人可隨時傳送聊天訊息,並等候回覆。通道上,此通話會導致錯誤。如果在聊天初始化之前呼叫此通話,或沒有開啟或已排入佇列的互動可供結束,此通話亦會導致錯誤。


cxone('chat', 'endContact');

在線上的即時聊天

即使沒有客服專員在线時,亦如同有客服專員可用一樣,顯示聊天視窗。


cxone('chat','enableChatAlwaysOnline');

保留先前聊天的自訂欄位

您可以選擇在互動啟動後是否希望自訂欄位保留或從本機儲存中清除。 這使您可以選擇哪些自訂欄位在與聯絡人的所有互動中繼續顯示。 'field_id'是指在建立自訂欄位時,Ident 欄位的值。

cxone('chat','enablePrecontactSurveyFieldAutoFill'('field id');

從Adaptive Cards發送回傳資料

Studio 個動作,而機械人可以透過聊天將Adaptive Cards傳送給聯絡人。 為了讓數位聊天能夠將回傳資料傳送到Studio或機器人,您必須啟用處理程式。 Adaptive Card 處理程式在 bot 或 Studio 動作中運作,以管理並回應與 Adaptive Cards 的互動。 當使用者與Adaptive Card的元件互動時(例如按一下按鈕或從下拉選單中選取選項),該處理程式便會啟動。 處理程式破解使用者的輸入並確定要採取的適當回應或動作。 新增預設處理程式命令及傳送訊息命令,以便Studio或bot可相應回應,或儲存Adaptive Card資料以作Reporting用途。 您也可以使用自訂處理程式命令來覆寫預設處理程式。

新增預設的自適應卡處理程式命令:


adaptiveCardOnExecuteAction(actionId: string, callback: (action: node_modules/adaptivecards/src/card-elements.ts::Action) => void)

傳送訊息命令:


 sendMessage(messageContent: MessageContent)

建立自訂處理程式命令:


{
	"acType": "Action.Execute", // type of action Action.Execute or Action.Submit
	"acVerb": "null|string", // only if `verb` is provided in the Action
	"acActionId": "null|string" // only if id is provided in the Action
	"acData": { // `data` are provided in Action
		"firstName": "Ichabod",
		"lastName": "Crane",
		"_messageText": "Did you fall asleep again?"
	}
}

設定授權碼或存取權杖

設定第三方 OAuth 認證的認證。授權碼流量請使用 setAuthorizationCode,並可搭配可選的 Proof Key for Code Exchange (PKCE) 程式碼驗證器。當您的網站已有存取權杖時,隱式流量請使用 setAccessToken。

OAuth 是一種驗證通訊協定。它可讓您讓一個應用程式代表您與另一個應用程式互動,而不會暴露密碼。若要使用 OAuth 驗證:

  • 在初始化聊天之前進行電話。初始化後進行的電話將被拒絕。
  • 僅使用授權碼或存取權杖,不可同時使用兩者。第二次電話將被拒絕。
  • PKCE 代碼驗證器為可選項目。如果您傳送一個,它必須為非空字串,並且您必須將它與為其生成的授權碼一併傳送。您不能單獨使用它。
  • 存取權杖必須為非空字串。它是一個有效的持有者認證,而非單次使用的代碼。NiCE CXone每次聯絡人傳送訊息時,都會向您的OAuth提供者查核該權杖,因此權杖過期後訊息便會傳送失敗。聊天視窗無法重新整理已過期的存取權杖,亦無法在初始化後接受新的權杖。請提供在預期聊天時長內維持有效的權杖。頁面重新載入後,請在再次初始化之前提供新的權杖。
  • 兩個值都不會寫入瀏覽器儲存,亦會從聊天視窗的日誌中已編輯。

若要使用授權碼流量:

cxone('chat', 'setAuthorizationCode', 'AUTHORIZATION_CODE');

要使用含有PKCE的授權代碼流量,亦需傳遞代碼驗證器:

cxone('chat', 'setAuthorizationCode', 'AUTHORIZATION_CODE', 'CODE_VERIFIER');

若要使用隱式流量(您的網站已經擁有存取 token):

cxone('chat', 'setAccessToken', 'ACCESS_TOKEN');

設定接觸前調查預先填寫欄位

Allows previously-entered custom field values to appear as an auto-fill option in later fields or interactions. Specific IDs inform the chat window which custom field values to save. When a contact begins a new conversation, these custom fields from previous conversations are automatically available. This helps save time if a contact needs to enter the same information in a new chat session that they've entered in a previous chat session, such as an email address. If there are multiple fields you want to appear as autofill options, include them all in the same API call.

cxone('chat', 'setPrecontactSurveyPrefilledFields', ['fieldIdent1', 'fieldIdent2']);

自動開始新的聊天會話

如果目前沒有進行中的工作階段,建立一個新的聊天訊息Closed 非同步聊天,聯絡人可隨時傳送聊天訊息,並等候回覆。或線上聊天Closed 座席與聯絡人以即時方式進行互動。工作階段。 在您網站流量較低的頁面上使用此調用,以避免客服人員負擔過重。

Digital Experience (DX) 建立一個新案例,並在發送聊天工作階段的第一條訊息時將其新增到佇列中。 聊天工作階段開始時,會代表客戶發送隱藏的自動訊息。 這可以透過更快地啟動流程來減少聯絡人等待客服專員的時間。 當聯絡人點擊聊天圖示開始對話或開啟自動啟動的聊天工作階段的聊天視窗時,聊天工作階段即已開始。 儘管初始訊息對客戶隱藏,但客服專員仍可以看到。

您可以自訂初始隱藏訊息的文字。

自動啟動聊天工作階段會跳過聯絡前調查表。 因此,您需要使用其他方法來收集有關聯絡人的資訊。 例如,您可以讓客服專員將訊息手動輸入到客戶卡中。 您也可以使用OAuth整合來配置客戶認證。

對於自動啟動個案,Routing是根據在Digital Experience (DX)中設定的路徑佇列Closed 決定將數位案件分派至哪些客服專員,所用標準例如客服專員具備處理該類型案件的專業知識。而發生的。 對於即時聊天工作階段,如果沒有可用的客服專員,聊天視窗會顯示等待空閒客服專員訊息。

若要自動啟動聊天工作階段,請按所示順序使用這些調用:


cxone('chat', 'openChatWindow');

cxone('chat', 'autoStartSession');

如果您在程式碼中加入其他通話,則autoStartSession必須始終是程式碼中的最後一次通話。例如:


// set customer name (as this is required field)
cxone('chat', 'setCustomerName', 'Elizabeth');

// open chat window so user can start to chat
cxone('chat', 'openChatWindow');

// and finally start the new chat session (without the pre-chat form)
cxone('chat', 'autoStartSession');

啟用並行聊天會話

您可以讓聯絡人在同一瀏覽器中啟動多個聊天會話。 如果聯絡人已在某個瀏覽器分頁進行活躍聊天,他們可以在新的瀏覽器分頁或視窗中開始第二個聊天。

指定使用以下其中一個選項來儲存聊天資料:

  • local: 數據在分頁或視窗關閉後,仍會保留在瀏覽器中。 這是預設的儲存方法。 如果多個聊天會話同時在不同分頁中開啟,它們將被視為同一個互動。 所有分頁中的聊天對話和體驗均相同。

  • session:資料會儲存於每個個別的分頁或視窗中,並在該分頁或視窗關閉時清除。這讓使用者可以在不同的分頁或視窗中開始多個聊天會話。每個聊天會話均視為獨立的互動。

  • inMemory:sessionId 和 customerId 僅在聊天應用程式的記憶體中使用。資料不會保存在瀏覽器中。重新整理瀏覽器會刪除所有記錄。這樣可在多個瀏覽器分頁或瀏覽器視窗中開啟時,啟用多個同時進行的聊天會話。

若要啟用同時聊天會話,請新增值為session或inMemory.的storageType金鑰。

如果您使用 storageType: 'local' 選項,並且仍想清除對話記錄,則可以建立事件偵聽程式,並在聊天結束後刪除 customerId。


cxone('chat', 
	'init',
	'MY_BRAND_ID_123',
	'MY_CHANNEL_ID_321',
	undefined,
	{
		storageType: 'session',
	},
);

清除對話歷史

聊天對話結束後刪除對話歷史。 如果您使用聊天的預設儲存選項 (localstorage),這可能會很有用。 即使瀏覽器實例關閉後,此儲存選項也會儲存資料。 在此情況下,您可以透過清除本地儲存中的 customerID 來專門移除對話記錄。 以下範例會建立一個事件接聽程式,以監聽來自聊天的 caseStatusChanged 事件。 這表示聊天會話結束。 之後會呼叫 removeItem 命令,以從瀏覽器的本地儲存中移除 customerID。


cxone('chat', 'onPushUpdate', ['CaseStatusChanged'], pushUpdatePayload => { 
	if (typeof pushUpdatePayload === 'undefined' || typeof pushUpdatePayload.data === 'undefined') { 
		return; 
	}  
	const { status } = pushUpdatePayload.data.case || {};   
	if (typeof status === 'undefined') { 
		return; 
	}   
	// When a previous case has been closed, this will set the custom fields again. 
	if (status === 'closed') { 
		localStorage.removeItem('_BECustomerID');  
	} 
}); 

自訂初始自動聯絡訊息

Digital Experience (DX) 建立一個新案例,並在發送聊天工作階段的第一條訊息時將其新增到佇列中。 聊天工作階段開始時,會代表客戶發送隱藏的自動訊息。 這可以透過更快地啟動流程來減少聯絡人等待客服專員的時間。 當聯絡人點擊聊天圖示開始對話或開啟自動啟動的聊天工作階段的聊天視窗時,聊天工作階段即已開始。 儘管初始訊息對客戶隱藏,但客服專員仍可以看到。

預設訊息是客戶點擊以開始對話的按鈕上的文字。 您可以透過三種方式自訂初始自動訊息的文字:

  • 覆寫預設按鈕文字。

cxone('chat', 'sendFirstMessageAutomatically', 'Hello');
  • 動態變更初始訊息。

cxone('chat', 'setFirstAutomatedMessageContent', 'Hello, I have a question');

使初始自動訊息對聯絡人可見

如果您希望聯絡人能夠看到初始自動訊息,請將此調用新增到指令碼中:


cxone('chat', 'hideFirstSentMessage', false);

延遲建立案例

Digital Experience (DX) 建立一個新案例,並在發送聊天工作階段的第一條訊息時將其新增到佇列中。 聊天工作階段開始時,會代表客戶發送隱藏的自動訊息。 這可以透過更快地啟動流程來減少聯絡人等待客服專員的時間。 當聯絡人點擊聊天圖示開始對話或開啟自動啟動的聊天工作階段的聊天視窗時,聊天工作階段即已開始。 儘管初始訊息對客戶隱藏,但客服專員仍可以看到。

您可以配置 Digital Experience (DX) 在使用此調用建立案例之前等待聯絡人實際發出第一條訊息:


cxone('chat', 'sendFirstMessageAutomatically', false);

啟用遊戲模式

允許聯絡人在等待客服專員時玩貪吃蛇遊戲。


cxone('chat', 'allowGameMode');

自動滿意度調查

可以自動偵測並在彈出式視窗中顯示滿足度調查。 此命令可以啟用或停用偵測和是否顯示。


cxone('chat', 'automatedSatisfactionSurveyModal', true);
cxone('chat', 'automatedSatisfactionSurveyModal', false);
//if not defined, the default is true

聊天資訊 JavaScript 通電話

這些調用允許您自訂聊天工作階段期間對聯絡人可用的訊息。

獲取客戶身份 id

返回聊天中客戶的唯一識別碼。


cxone('chat', 'getCustomerIdentityId');

隱藏接觸前調查表單

在聊天訊息Closed 非同步聊天,聯絡人可隨時傳送聊天訊息,並等候回覆。工作階段開始時,會顯示聯絡前調查表。 此調查表會收集有關聯絡人的資訊,例如他們的姓名。 如果需要,您可以隱藏聯絡前調查表,並在聯絡人啟動聊天訊息工作階段時立即顯示聊天視窗。


cxone('chat', 'hidePreSurvey');

隱藏佇列計數器

佇列計數器能夠讓聯絡人知道,根據聯絡人在客服專員佇列中的位置,客服專員多久能與其通話。 您可以在聯絡人被成功路由到客服專員後隱藏佇列計數器。 這允許客服專員從其收件匣中刪除客戶卡而不被聯絡人注意到。


cxone('chat', 'hideQueueCounterAfterAssignment');
cxone('chat', 'hideAssignedAgent');
cxone('chat', 'hideSystemMessages');

將聊天通知音訊靜音

允許您關閉聊天通知聲音。 聊天通知聲音預設為開啟。 無論其他聊天聲音設定如何,都需要配置此項目。 您可以將值變更為 false,以重新開啟聊天通知音效。


cxone('chat', 'muteAudioNotification', true);
// OR
cxone('chat', 'muteAudioNotification');

覆寫瀏覽器語言翻譯

將使用者的瀏覽器語言設定或自訂區域設定覆寫為設定的翻譯。 例如,您可以確保某些文字始終以英文顯示,無論聯絡人的瀏覽器語言設定為何。


cxone('guide', 'init', 'brandId', 123, 'locale');

設定活動狀態

變更活動列中的訊息。 例如,您可以使用它來傳輸您對聊天訊息工作階段的回應時間。這可能會有所幫助,因為聊天訊息是一種異步的聊天形式,聯絡人可能必須等待接收客服專員的訊息。


cxone('chat', 'setStatusMessage', 'We typically reply within 3 hours.');

設定客服專員的影像

動態變更聊天視窗中顯示的客服專員圖像。 依預設,Digital Experience (DX) 會使用客服專員設定檔中的圖像。當您在指令碼中包含此調用時,會使用程式碼片段中以 URL 指定的圖像。 將示例 URL 替換為您希望聊天使用的圖像的 URL。


cxone('chat', 'setAgentImage', 'http://classics.com/images/agents/elizabeth_bennet.png');

設定客戶 ID

設定聊天中客戶的唯一識別碼。


cxone('chat', 'setCustomerId', 'customer_id');

設定客戶名稱

客戶名稱是聊天前調查表中的一個欄位,聯絡人需要在與聊天訊息Closed 非同步聊天,聯絡人可隨時傳送聊天訊息,並等候回覆。通道中的客服專員聯絡前填寫。 此調用動態填充此欄位。


cxone('chat', 'setCustomerName', 'Elizabeth');

設定日期格式

可以設定為使用絕對日期格式 (12/03/2035) 或相對日期格式(今天,星期一)。


cxone('chat', 'setDateFormat', 'date_format');
// date_format can be 'absolute' or 'relative'

設定地區設定

設定聊天視窗中的翻譯區域。


cxone('chat', 'setLocale', 'locale');

顯示案例資訊

僅適用於chat messagingClosed 非同步聊天,聯絡人可隨時傳送聊天訊息,並等候回覆。渠道。 向聯絡人顯示案例資訊。


cxone('chat', 'showCaseInfo');

顯示/隱藏傳送文字記錄按鈕

如果您將傳送轉錄按鈕設定為顯示,您必須配置聊天通道以允許聯絡人將聊天轉錄傳送給自己。為聊天訊息或即時聊天配置此選項。


cxone('chat', 'hideSendTranscript');
cxone('chat', 'showSendTranscript');

顯示/隱藏系統訊息

顯示或隱藏系統訊息,如客服專員指派歷程。


cxone('chat','hideSystemMessages');
cxone('chat', 'showSystemMessages');

使用條款

您可以在聊天視窗中向聯絡人提供使用條款文件。 此功能會在視窗中新增一個按鈕。您可以自訂按鈕的標籤和樣式,以及聯絡人點擊後會執行的動作。 點擊動作可以將使用條款顯示為:

  • 一個內部視窗
  • 外部連結

// Internal Modal Window
cxone('chat', 'showTermsOfUse', 'Show terms of Use', 'modal' , 'Our terms of use are ...');

// External Link
cxone('chat', 'showTermsOfUse', 'Show terms of Use', 'externalLink' , 'http://yourdomain.com/terms-of-use');

// If you want to explicitly disable this feature, you can use
cxone('chat', 'hideTermsOfUse');

若要自訂按鈕或內部視窗的外觀,請使用本頁面中所述的 CSS API 調用。

自訂欄位、標籤和短語

建立和填充自訂欄位

在使用以下的自訂欄位 API 呼叫之前,您必須先在NiCE CXone中建立自訂欄位。請為Customer Card或Contact建立自訂欄位,視乎您想透過 API 填充哪一種類型的自訂欄位而定。

在建立自訂欄位時指派的 ident 值,與您在 API 調用中所參考的值相同。如果該自訂欄位在平台中不存在,則 API 調用將不會產生任何效果。

有關建立自訂欄位的逐步指引,請參閱管理自訂欄位。

請使用CXone Digital Chat JavaScript API捕獲您網頁上的資料,並將其儲存為自訂欄位值。這樣,當聊天互動開始時,您便可以自動將內容相關資訊(例如訪客所在的頁、其帳戶 ID,或任何其他相關資料)直接傳送至 NiCE CXone。

有兩種API方法可供使用,視乎您想將自訂欄位資料儲存在何處而定:

  • setContactCustomField — 將自訂欄位值儲存在Contact上,此 Contact 代表單一互動或對話。當資料為該特定聊天會話所專用時,請使用此選項。例如,發起聊天的頁面 URL、所選的產品,或表單參考編號。

    當使用 setCaseCustomField 時,您可能會在瀏覽器主控台中看到棄用警告,建議您改用 setContactCustomField。

  • setCustomerCustomField — 將自訂欄位值儲存在Customer Card上,此欄位代表客戶在所有互動中的設定檔。當資料與客戶本身相關時,請使用此項。例如,其帳戶 ID、會員等級或偏好語言。

實作概覽

以下表格概述了可用於設定自訂欄位值的 API 方法。有關實作指引,請參閱表格下方的詳細程式碼範例。

example

API 方法

描述

設定單一聯絡自訂欄位setContactCustomField用於一次填入一個案例欄位。
設定多個聯絡自訂欄位setContactCustomFields有效率地批量更新多個案例欄位。
設定單一 Customer Card 自訂欄位setCustomerCustomField針對 Customer Card 設定檔欄位。
Set 多個 Customer Card 自訂欄位setCustomerCustomFields大量更新多個Customer Card欄位。
靜態值範例setContactCustomField硬式編碼值,例如 '聯絡我們頁'。
動態值範例setContactCustomField動態值,例如 window.location.href。

自訂欄位的值可以透過兩種方式設定:

靜態 — 此數值直接硬編碼於 API 調用中。當某頁的數值一律相同時,此方法十分有用,例如標示聊天小工具所在的頁。

  • 單一聯絡自訂欄位的值定義

    cxone('chat','setContactCustomField', 'pagesource', 'Contact Us Page');
  • 要定義多於一個聯絡人自訂欄位的值

    cxone('chat','setContactCustomFields',
       {
       customFieldIdent: 'value',
       secondCustomFieldIdent: 'value'
       } 
       );
     
  • 要定義單一 Customer Card 欄位的值

    cxone('chat','setCustomerCustomField', 'email', 'leia@starwars.com');
  • 要定義多於一個 Customer Card 欄位的值

    cxone('chat','setCustomerCustomFields',
       {
       customFieldIdent: 'value',
       secondCustomFieldIdent: 'value'
       } 
       );
     
  • 動態 — 此值是在執行階段使用 JavaScript 從網頁擷取的。當值會因訪客或工作階段而異時,此功能非常有用,例如擷取目前頁面 URL 或已登入使用者的 id。

    cxone('chat','setContactCustomField', 'currentPage', window.location.href);

如果您使用聯絡前表格在聊天開始前收集訪客的資訊,則無需使用這些 API 方法來捕獲相同的資料。聯絡前表格欄位會依照設定自動儲存至個案和客戶卡。

To define the value of a Customer Card 自訂欄位:

cxone('chat','setCustomerCustomField', 'ident_of_custom_field', 'value_of_custom_field');

自訂欄位最多限為1024個字元。

將自訂欄位 API 呼叫新增至同一個程式碼區塊中,該區塊即是您網頁上嵌入 Guide widget 的位置。請將 API 呼叫放置在結束的 </script> 標記之前,即小部件初始化程式碼之後。例如:

<script>
   // CXone widget initialization code
   cxone('guide', 'init');
   // Add custom field API calls here
   cxone('chat', 'setCaseCustomField', 'pageSource', 'Contact Us Page');
   cxone('chat', 'setCustomerCustomField', 'accountTier', 'Premium');
   </script>

有關嵌入小工具及在何處放置自訂呼叫的詳細指引,請參閱使用 JavaScript 自訂 Guide。

自訂聊天標籤和短語

您可以自訂數位聊天通道使用的許多標籤和短語,以及定義自訂。 如果您需要動態變更短語或螢幕標籤,請使用這些 JavaScript 調用。

若要變更單個訊息或標籤:


cxone('chat', 'setTranslation', 'key', 'your translation');

若要變更多個訊息或標籤:


cxone('chat', 'setTranslations', {
   key1: 'your custom label',
   key2: 'your custom message'
});

翻譯自訂欄位

您可以翻譯聊天視窗中顯示的自訂欄位。


cxone('chat', 'setCustomTranslations', {
    myCustomFieldATranslationKey: "Custom field value A",
    myCustomFieldBTranslationKey: "Custom field value B",
});

聊天視窗外觀調用

您可以修改聊天視窗的外觀。

關閉聊天圖示

設定為 True 時,視窗上將顯示 X 圖示,而不是設定選單中的「結束聊天」選項。


cxone('chat', 'enableCloseIcon', true);

隱藏已指派客服專員


cxone('chat', 'hideAssignedAgent');

隱藏標頭


cxone('chat', 'hideHeader');

隱藏彈出視窗


cxone('chat', 'hidePopups');

顯示客戶頭像


cxone('chat', 'showCustomerAvatar');

顯示發送按鈕


cxone('chat', 'showSendButton');

尺寸

自訂聊天視窗的寬度和高度。 您可以使用 CSS 規範支援的絕對或相對單位。


cxone('chat', 'setWindowWidth', '100%');
cxone('chat', 'setWindowHeight', '100%');

全部顯示模式


cxone('chat', 'setFullDisplay');
// OR
cxone('chat', 'setWindowWidth', '100%');
cxone('chat', 'setWindowHeight', '100%');

位置和偏移

setPositionX 電話將螢幕的左側或右側定義為起始位置。setOffsetX 及 setOffsetY 電話分別定義聊天視窗從起始點水平及垂直偏移的像素數目。


// set horizontal starting position
cxone('chat', 'setPositionX', 'right');
													
// set horizontal and vertical offset
cxone('chat', 'setOffsetX', '40'); // default = 20
cxone('chat', 'setOffsetY', '40'); // default = 20

為回覆框設定字元限制


cxone('chat', 'setReplyBoxLimit', '280'); // default = null

帶有資料選擇器的自訂 CSS

您可以新增自己的 CSS 來定制聊天視窗的外觀。 使用 data-selector 屬性指定要樣式化的聊天視窗部分。 下面的下拉式清單包含所有可使用 data-selector 屬性選擇的元件清單。 資料選擇器允許您指定要套用自訂 CSS 的聊天視窗部分。 在 data-selector 之後,在大括弧內新增您的樣式。 如果您想要設定多個元素的樣式,則必須在單一 JavaScript 調用中新增所有 CSS。 如果您多個次使用相同的JavaScript電話,最後一次JavaScript電話將會覆蓋之前所有CSS。 您亦可以直接在NiCE CXone中自訂CSS,用於聊天。

要使用資料選擇器新增自訂 CSS,請使用以下 JavaScript 調用作為參考:

cxone('chat', 'setCustomCss', '[data-selector="CUSTOMER_MESSAGE_BUBBLE"] {color: white !important; background: black !important} 
[data-selector="CONTENT"] {background: green !important}`);

以下章節包含可用的資料選擇器。

核心容器和佈局

  • 信差
  • 視窗
  • QUEUE_WINDOW
  • 內容
  • SCROLL_BOX_WRAPPER
  • SCROLL_BOX_CONTENT
  • SCROLL_DOWN_BUTTON
  • SCROLL_DOWN_UNREAD_BADGE

Header 和導覽

  • 標頭
  • GROUP_CHAT_HEADER_ICON
  • HEADER_ACTION_MENU_BUTTON
  • 視窗最小化標題
  • DROPDOWN_MENU
  • 對話記錄

訊息

  • 客戶訊息
  • AGENT_MESSAGE
  • CUSTOMER_MESSAGE_BUBBLE
  • AGENT_MESSAGE_BUBBLE
  • 工具提示訊息
  • 訊息_狀態_LINE
  • 訊息時間戳記
  • IS_TYPING
  • 分隔符號
  • 載入更多訊息
  • LOAD_MORE_MESSAGES_BUTTON

User 和客服專員資訊

  • USER_PROFILE
  • USER_NAME
  • 使用者狀態
  • UseR_STATUS_DOT
  • 頭像
  • DEFAULT_AVATAR
  • END_SESSION
  • END_SESSION_AGENT_NAME
  • END_SESSION_AGENT_PROFILE
  • END_SESSION_BODY
  • 結束工作階段頁尾

輸入與回覆

  • REPLY_BOX
  • 輸入值
  • 輸入錯誤
  • 文字區域
  • TEXT_按鈕
  • 主要_BUTTON
  • 次要按鈕
  • BUTTON_標籤
  • 取消按鈕
  • 傳送按鈕
  • UPLOAD_ATTACHMENT_BUTTON_CONTAINER
  • UPLOAD_ATTACHMENT_BUTTON
  • SEND_TRANSCRIPT
  • START_NEW_CHAT
  • END_CHAT_SESSION_BUTTON

表格和問卷調查

  • FORM_FIELD_CONTAINER
  • 標籤欄位表單
  • FORM_FIELD_ERROR_MESSAGE
  • PRECONTACT_SURVEY
  • PRECONTACT_SURVEY_DESCRIPTION
  • PRECONTACT_SURVEY_FOOTER
  • 聯繫前調查主要容器
  • SATISFACTION_SURVEY

主動式及模式彈出式視窗

  • PROACTIVE_CHAT_POPUP
  • 主動式聊天完整影像
  • 主動式聊天影像
  • PROACTIVE_CHAT_CONTENT
  • PROACTIVE_CHAT_HEADING
  • PROACTIVE_CHAT_SUBHEADING
  • PROACTIVE_CHAT_BODY
  • PROACTIVE_CHAT_ACTION_BUTTON
  • PROACTIVE_CHAT_CLOSE_BUTTON
  • 主動式聊天 HTML 彈出
  • INACTIVITY_POPUP
  • 不活動彈出視窗標題
  • INACTIVITY_POPUP_BODY
  • INACTIVITY_POPUP_CALL_TO_ACTION
  • 不活動彈出計時器
  • 閒置狀態
  • ENDCHAT_INACTIVITY_狀態
  • 使用條款彈出視窗
  • 使用條款
  • END_CHAT_MODAL
  • 模態主要內容
  • MODAL_ACTIONS
  • 彈出

狀態和連接

  • 連線狀態
  • OFFLINE
  • 離線圖示
  • 离线文字
  • SKELETON_LOADER

雜項

  • DROPZONE_WRAPPER
  • TRANSCRIPT

僅使用 data-selector 屬性套用自訂 CSS 元件。 不要將其套用於如下列範例中的類別選擇器JavaScript程式碼的其他部分:

.Widget__Widget___1qQCf { background: red; }

視窗元件可以由多個巢套塊組成。 本節中列出的組件選擇器會命名每個元件的根。 如果您希望將 CSS 套用於元件的巢套塊之一,請使用開發人員的控制台檢查元件,以便您可以選擇正確的巢套塊。

主動動作

本節中的調用允許您根據客戶的行為主動參與聊天。

執行觸發器

啟動由 trigger_id 所定義的 Workflow Automation 觸發器。


cxone('chat', 'executeTrigger', 'trigger_id');

設定訪客事件

存儲用於報告的已定義的客戶行為(事件)。 當此電話與Mobile SDK一併使用時,event_type 會變更為 custom_event_type。


cxone('chat', 'setVisitorEvent', 'event_type', 'custom_event_data');

設定訪客變數

存儲用於報告的已定義的客戶資訊。


cxone('chat', 'setVisitorVariable', 'variable_identifier', 'variable_value');

存儲轉換

存儲用於報告的可轉換的客戶行為。


cxone('chat', 'storeConversion', 'conversion_type', 'conversion_value', 'conversion_date'); 
// conversion_date is optional, default is now

網路訪客標記

此部分中的內容適用於正處於公共預覽程式中的產品或功能。如果您並未參與此預覽,並希望瞭解更多資訊,請聯絡您的客戶代表。

您可以對在您的網站上表現出特定行為的聯絡人進行標記。 此功能使用來自 Digital Experience (DX) 的標記,並需要Guide。

要向聯絡人新增標記:


cxone('chat', 'assignTag', 'tagID');

要刪除聯絡人的標記:


cxone('chat', 'removeTag', 'tagID');

與第三方應用程式整合

本節中的叫用操作允許您在發生某些聊天事件時接收推送通知。

識別聊天視窗中的作用中執行緒


cxone('chat', 'getOngoingThreads');

識別聊天視窗中正在進行的聯絡


cxone('chat', 'getOngoingContact')

接收特定聊天事件的推送通知

以下列表包含相容的事件。請使用以下任何輸入來取代下方範例中的「event」。

  • CaseToRoutingQueueAssignmentChanged

  • PageViewCreated

  • MessageCreated

  • MessageDeliveredToUser

  • MessageDeliveredToEndUser

  • MessageSeenByUser

  • MessageSeenByEndUser

  • MessageReadChanged

  • MessageAddedIntoCase

  • CaseInboxAssigneeChanged

  • CaseCreated

  • CaseStatusChanged

  • SenderTypingStarted

  • SenderTypingEnded

  • MessageNoteCreated

  • ContactRecipientsChanged

要接收一個聊天事件的通知:


cxone('chat', 'onPushUpdate', 'event', callback);

要接收多於一個聊天事件的通知:


cxone('chat', 'onPushUpdate', ['event', 'event', 'event'], callback);

要接收所有聊天事件的通知:


cxone('chat', 'onAnyPushUpdate', callback);

整合至Android或 iOS 應用程式

您可以將數位聊天整合到 Android 或 iOS 應用程式中。 原生應用程式必須使用新增JavaScript初始化程式碼的 WebView。 此範例程式碼使用此頁中的 JavaScript,以修改聊天函數的外觀和行為。


<script async type="text/javascript">
  (function(i,s,o,r,g,v,a,m){g=v?g+'?v='+v:g;i['BrandEmbassy']=r;
    i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)};i[r].l=+new Date();
    a=s.createElement(o);m=s.getElementsByTagName(o)[0];a.async=1;
    a.src=g+'?'+Math.round(Date.now()/1000/3600);m.parentNode.insertBefore(a,m)
  })(window,document,'script','brandembassy','https://livechat-static.brandembassy.com/3/chat.js');

  //init of Livechat
  cxone('chat', 'init', BRAND_HASH);

  // hiding unwanted UI elements
  cxone('chat', 'hideHeader');
  cxone('chat', 'hidePopups');
 
  // stretching livechat to full width and height
  cxone('chat', 'setFullDisplay');

  // Customer's name
  cxone('chat', 'setCustomerName', 'CUSTOMER_NAME');

  // Other optional Custom Fields
  cxone('chat', 'setCustomField', 'CUSTOM_FIELD_IDENT', 'CUSTOM_FIELD_VALUE');
    
  // Start Chat
  cxone('chat', 'openChatWindow');
  cxone('chat', 'autoStartSession');

</script>