跳到內容
KeuralDocs
開發人員

聊天機器人

使用安裝程式碼,在組織網站中加入 Keural 聊天機器人按鈕。

組織可以在自己的網站中加入 Keural 聊天機器人。訪客按下畫面角落的按鈕後,聊天機器人視窗就會開啟。只要貼上在管理畫面中建立的安裝程式碼即可完成安裝。

建立聊天機器人

  1. 組織擁有者或管理員在 組織管理 → 聊天機器人 中按下 + 新增聊天機器人。
  2. 輸入聊天機器人名稱與預設網域(例如 https://example.com),然後完成登錄。
  3. 開啟聊天機器人,設定三個分頁。
分頁設定
Token 與安裝確認權杖,並複製安裝程式碼(HTML · Next.js)
聊天機器人介面按鈕圖片(PNG·JPG·GIF·WebP)與是否顯示、聊天機器人名稱、標題列的顯示與展開、標題列顏色、按鈕顏色、按鈕位置(左側或右側)以及水平與垂直位移。可透過預覽確認
進階聊天機器人可開啟的頁面位址(允許的網域,最多 5 個)
  1. 將安裝程式碼貼到你的網站中。

安裝程式碼

在 Token 與安裝 分頁中,複製 HTML 或 Next.js 的程式碼。程式碼由兩個部分組成。

  • 載入器:建立 Keural 函式,頁面載入完成後,以非同步方式載入聊天機器人腳本(/plugin/keural-widget@1.0.1.js)。腳本載入前呼叫的指令會先排入佇列,然後依序執行。
  • 啟動指令:Keural('boot', { token: '…' })。權杖以 wgt_ 開頭。

腳本版本已固定在位址中。出現新版本時,請重新複製安裝程式碼並替換。在同一頁面中放入兩次安裝程式碼時,第二次的程式碼會被忽略,並在主控台留下錯誤。

<script id="keural-one-script">
  /* 從「Token 與安裝」分頁複製的程式碼 */
</script>

在 Next.js 中,請以 next/script 的 <Script id="keural-one-script" strategy="afterInteractive"> 加入。若要在所有頁面中顯示,請放在根版面配置中。

啟動選項

傳給 boot 的值優先於管理畫面中的設定。需要依頁面變更外觀時使用。

Keural('boot', {
  token: 'wgt_…',
  theme: 'system',
  header: { enabled: true, extended: true, draggable: true, title: '客戶支援', color: '#495BD8' },
  button: { visible: true, iconUrl: 'https://example.com/icon.png', color: '#495BD8', position: 'right', offsetX: 30, offsetY: 30 },
});
選項值管理畫面中的設定名稱
token必填。安裝程式碼中的權杖—
themelight · dark · system—
header.enabled顯示標題列標題列顯示
header.extended在標題列顯示放大按鈕標題列展開
header.draggable拖曳標題列以移動視窗(預設 true)—
header.title標題列標題聊天機器人名稱
header.color標題列顏色標題列顏色
button.visible顯示按鈕顯示按鈕
button.iconUrl按鈕圖片位址按鈕圖片
button.color按鈕顏色按鈕顏色
button.positionleft · right按鈕位置
button.offsetX · button.offsetY距離螢幕邊緣的距離(px)X 位移 · Y 位移

新建立的聊天機器人預設值為:標題列顯示與展開開啟,標題列與按鈕顏色 #495BD8,位於右側,位移 30px,佈景主題 system。

頁面控制

呼叫動作
Keural('open') · Keural.open()開啟聊天機器人視窗。
Keural('close') · Keural.close()關閉。
Keural('toggle') · Keural.toggle()若已開啟則關閉,若已關閉則開啟。
Keural('reload') · Keural.reload()重新載入聊天機器人視窗。
Keural('badge', n) · Keural.badge(n)在按鈕上顯示數字徽章。
Keural.isLoaded()腳本載入完成時為 true
Keural.onOpen(cb) · Keural.onClose(cb)視窗開啟或關閉時呼叫 cb。

Keural.open() 等方法只有在腳本載入後才會生效。頁面載入後立即呼叫時,請使用 Keural('open') 這種函式形式,它們會依序執行。

<button onclick="Keural('open')">諮詢</button>

也可以隱藏預設按鈕(button.visible: false),改用頁面上的按鈕開啟。

畫面大小

聊天機器人視窗為 390×800px,畫面寬度為 480px 以下時會以全螢幕開啟。可使用標題列的放大按鈕放大視窗。

顯示網域

  • 聊天機器人會在主機與 預設網域 相同的頁面中開啟。主機比較時包含連接埠,且不區分大小寫。帶有 www. 的位址與子網域為不同的主機。若要在開發伺服器上測試,請另外建立一個以該位址為預設網域的聊天機器人。
  • 預設網域建立後無法變更。若要變更,請重新建立聊天機器人。
  • 若將 進階 中的允許網域留空,會在預設網域的所有頁面中開啟。填入允許網域時,只會在以該位址開頭的頁面中開啟。若寫到路徑(例如 https://example.com/help),範圍會縮小到該路徑下的頁面。允許網域以 http:// 或 https:// 開頭,最多可填 5 個。
  • 安裝程式碼中的權杖會顯示在頁面上。請只將可以公開的內容連接到聊天機器人。

安全性政策(CSP)

若網站已套用 Content-Security-Policy,請允許以下項目。位址以 keural.ai 為準。

指令允許的內容
script-srchttps://keural.ai,以及安裝程式碼的內嵌腳本('unsafe-inline' 或雜湊、nonce)
connect-srchttps://api.keural.ai
frame-srchttps://keural.ai
style-src'unsafe-inline' 或 nonce(聊天機器人會將樣式加入頁面)
img-src按鈕圖片位址、https://keural.ai、https://api.keural.ai

本頁內容