聊天 Widget

嵌入您網站嘅聊天 Widget 所使用嘅所有端點。

聊天 Widget 將您嘅聊天機械人嵌入到您嘅網站入面。呢個分組描述 Widget 所使用嘅所有端點:可用性檢查、公開 Widget 設定、傳送訊息、對話記錄、取得新訊息(例如喺客服接管對話之後)、評分、使用事件,以及語音輸入同輸出。

為咗令 Widget 可以喺瀏覽器初始化,`health`同`config`可以喺唔需要身份驗證嘅情況下呼叫。其餘所有端點都要求喺`X-Widget-Token`標頭提供 Widget 嘅`widget_code`同嵌入權杖。Zentor 會喺設定嗰時建立呢個 Widget,儲存已批准嘅域名,並為您提供包含 Widget 代碼同嵌入權杖嘅嵌入代碼。伺服器會以403 `WIDGET_ORIGIN_DENIED`拒絕嚟自未批准域名嘅呼叫,並以404 `WIDGET_DISABLED`回應已停用 Widget 嘅呼叫。

另外,您帳戶嘅存取規則(IP、國家同域名規則)都適用。`message`唔係冪等嘅:每次重新傳送都會產生另一條訊息同另一個回應。

GET/api/public/widget/healthGET/api/public/widget/config/:widget_codePOST/api/public/widget/messageGET/api/public/widget/historyPOST/api/public/widget/pollPOST/api/public/widget/ratingPOST/api/public/widget/trackPOST/api/public/widget/voice-transcribePOST/api/public/widget/voice-speak
← API 參考