POST/api/global-chatbot/demo/voice-speak
如果示範嘅語音功能已經啟用,就將文字轉換成語音(示範頁面嘅語音輸出)。
傳送`visitor_id`(UUID)以及要讀出嘅文字`text`。回應會包含用於播放嘅音訊數據;對於`<audio>`元素,同一路徑亦可以透過GET使用。呢個端點對應`POST /api/public/widget/voice-speak`,但只限用於 zentor-app.de 嘅示範,並唔係打算作為通用嘅文字轉語音介面。 錯誤情況:400 `INVALID_VISITOR_ID`(UUID缺失或者無效)、403 `ORIGIN_DENIED`(呼叫唔係嚟自 zentor-app.de)同503 `VOICE_UNAVAILABLE`(語音功能而家唔可以用)。
概覽
調用:POST /api/global-chatbot/demo/voice-speak。此端點屬於 Zentor App API 的「示範聊天機械人同 SSO」組別。 此端點可公開存取,毋須身份驗證。 此調用屬冪等:以相同輸入重複調用,將傳回相同結果。 必填參數:visitor_id (請求主體), text (請求主體)。 已記錄的錯誤情況:400 INVALID_VISITOR_ID, 403 ORIGIN_DENIED, 503 VOICE_UNAVAILABLE。 下方的範例回應展示 JSON 格式成功回應的結構。
身份驗證同安全保障
唔需要身份驗證
只接受嚟自 https://zentor-app.de 同 https://www.zentor-app.de 嘅呼叫;示範唔需要嵌入權杖。
冪等: 係
參數
visitor_id(body, string,必填)— 訪客 ID,必須係有效嘅 UUIDtext(body, string,必填)— 要讀出嘅文字回應範例
{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Sprachfunktion aktuell nicht verfügbar."}}錯誤代碼
400 INVALID_VISITOR_ID — `visitor_id`缺失或者唔係有效嘅 UUID。403 ORIGIN_DENIED — 呢個呼叫唔係嚟自 zentor-app.de。503 VOICE_UNAVAILABLE — 語音功能而家唔可以用。已驗證嘅行為
無效嘅`visitor_id`會回傳400 `INVALID_VISITOR_ID`,唔可以用嘅語音功能就會回傳503 `VOICE_UNAVAILABLE`。成功情況只可以從 zentor-app.de 發起。
示範聊天機械人同 SSO
POST /api/global-chatbot/demo向 zentor-app.de/demo 嘅公開示範聊天機械人傳送訊息並回傳佢嘅回應。示範可以喺瀏覽器唔需要註冊就試用。GET /api/global-chatbot/demo/history載入示範對話之前嘅訊息記錄,方便重新打開示範嗰時都保留落嚟。POST /api/global-chatbot/demo/poll取得示範對話嘅新訊息,例如當 Zentor 嘅職員接管咗對話嗰時。示範頁面會定期呼叫呢個端點。POST /api/global-chatbot/demo/rating儲存示範對話嘅評分(有幫助或者冇幫助),可以加可選評論。POST /api/global-chatbot/demo/track為 Zentor 嘅訪客統計,記錄示範頁面嘅匿名使用事件。POST /api/global-chatbot/demo/voice-transcribe如果示範嘅語音功能已經啟用,就將示範頁面嘅錄音轉換成文字(語音輸入)。GET /api/sso/:tenantSlug/status檢查某個帳戶係否已經配置單一登入(SAML 或者 OIDC)。登入頁面會用呢個結果提供 SSO 登入選項。GET /api/sso/:tenantSlug/oidc/start開始透過 OpenID Connect 嘅登入,並將瀏覽器重新導向去已配置嘅身份提供者。GET /api/sso/:tenantSlug/oidc/callback接收 OIDC 登入之後身份提供者嘅重新導向,並將瀏覽器重新導向返去 Zentor App。GET /api/sso/:tenantSlug/saml/start開始透過 SAML 嘅登入,並將瀏覽器重新導向去已配置嘅身份提供者。POST /api/sso/:tenantSlug/saml/acsAssertion Consumer Service(ACS):透過表單 POST 接收身份提供者已簽署嘅 SAML 回應。GET /api/sso/:tenantSlug/saml/metadata回傳要匯入您身份提供者嘅 Zentor App SAML 元數據(XML)。