Widget API
供開發者使用,或適合任何想從自己的按鈕開啟聊天的人。
安裝中
<script src="https://keyda.in/business/widget.js"
data-key="kb_live_your_key_here" async></script>腳本標籤只需要 src 和 data-key。其他一切——顏色、位置、問候語、語言——皆來自您的控制台,因此您永遠不需要為了變更它們而重新部署網站。
模式
懸浮(預設)。 位於角落的啟動按鈕,點擊後會開啟聊天面板。
內嵌模式。 在頁面上放置一個空的容器,聊天視窗就會填滿該區域:
<div data-keyda-bot style="height:520px"></div>容器需要設定高度。在內嵌模式下,對話視窗隨時可見,因此沒有開啟或關閉的問題。
JavaScript API
指令碼載入後即可在 window.KeydaBot 上使用:
| 通話 | 它的功能 |
|---|---|
KeydaBot.open() | 開啟聊天面板 |
KeydaBot.close() | 關閉它 |
KeydaBot.toggle() | 開啟或關閉 |
KeydaBot.expand() | 讓面板與視窗等高,寬度可達 760px |
KeydaBot.shrink() | 返回標準卡片 |
KeydaBot.isOpen | true 當聊天視窗顯示時 |
KeydaBot.isExpanded | true 當面板展開時 |
KeydaBot.clientId | 此頁面正在使用的 client id |
範例 — 從您自己的「聯絡我們」按鈕開啟對話:
<button onclick="KeydaBot.open()">Chat with us</button>此 script 是非同步載入的,因此在頁面載入後的一瞬間,
window.KeydaBot 可能尚未存在。請將處理常式附加至點擊事件,而非在頁面解析時直接呼叫。它在您的頁面上的行為表現
- 面板會開啟在啟動按鈕的 上方,該按鈕會固定在原處並變更為關閉控制項。再次點擊它、點擊標題中的 ✕,或按下 Escape 鍵即可關閉對話。
- 訪客可以從標頭展開面板——它會擴展至視窗高度且最大寬度為 760px——且瀏覽器會記住此選擇。在手機上,面板預設即為全螢幕,因此不會顯示該控制項。
- 您的 logo 大小 設定會更改 logo 而不是按鈕:啟動器為固定的 52px 膠囊狀(圓形和方形形狀為 58px),logo 會在其中放大。
- 所有內容都在 shadow root 內渲染,因此您的 CSS 無法破壞小工具,小工具的 CSS 也無法影響您的網站。
- 面板只有在訪客開啟時才會載入,因此不會拖慢您的網頁速度。
- 訪客如果再次造訪,對話會在 24 小時內持續,之後會重新開始。
- 如果無法連線至助理,小工具會顯示簡短訊息,絕不會在你的網頁中丟出錯誤。