POST/api/public/widget/voice-speak

Zamienia tekst na mowę (wyjście głosowe w widżecie), jeśli funkcja głosowa jest aktywowana.

Wyślijcie `widget_code` i tekst do odczytania w `text`. Odpowiedź zawiera dane audio do odtworzenia w przeglądarce. Do bezpośredniego odtwarzania przez element `<audio>` ta sama ścieżka jest dostępna także przez GET. Jeśli brakuje `widget_code`, serwer odpowiada 400 `WIDGET_CODE_REQUIRED`; jeśli funkcja głosowa nie jest aktywowana lub jest aktualnie niedostępna, 503 `VOICE_UNAVAILABLE`. Funkcję głosową dla Waszego widżetu konfiguruje Zentor. Zaczynajcie nowe odtwarzanie tylko wtedy, gdy poprzednie się zakończyło.

Przegląd

Wywołanie: POST /api/public/widget/voice-speak. Ten endpoint należy do grupy „Widżet czatu” API Zentor App. Wymaga ważnego tokenu osadzania widżetu. Wywołanie jest idempotentne: powtarzane wywołania z tymi samymi danymi zwracają ten sam wynik. Parametry wymagane: widget_code (body), text (body). Udokumentowane przypadki błędów: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. Poniższa przykładowa odpowiedź pokazuje strukturę udanej odpowiedzi w formacie JSON.

Uwierzytelnianie i zabezpieczenia

Token osadzenia widżetu (nagłówek X-Widget-Token) + lista dozwolonych originów

Idempotentny: Tak

Parametry

widget_code(body, string, wymagane)— Kod widżetu z Waszego kodu osadzania
text(body, string, wymagane)— Tekst do odczytania

Przykładowa odpowiedź

{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Funkcja mowy jest obecnie niedostępna."}}

Kody błędów

400 WIDGET_CODE_REQUIRED — Brakuje pola `widget_code`.
503 VOICE_UNAVAILABLE — Funkcja głosowa nie jest aktywowana dla tego widżetu lub jest aktualnie niedostępna.

Zweryfikowane zachowanie

Brakujący `widget_code` zwraca 400 `WIDGET_CODE_REQUIRED`, widżet bez funkcji głosowej 503 `VOICE_UNAVAILABLE`. Przypadek sukcesu wymaga widżetu z aktywowaną funkcją głosową.

Widżet czatu

GET /api/public/widget/healthProste sprawdzenie dostępności usługi widżetu.GET /api/public/widget/config/:widget_codeZwraca publiczną konfigurację widżetu (nazwa wyświetlana, powitanie, wygląd, język, funkcja głosowa) do inicjalizacji w przeglądarce.POST /api/public/widget/messageWysyła wiadomość odwiedzającego do chatbota i zwraca jego odpowiedź — centralny punkt końcowy widżetu czatu.GET /api/public/widget/historyWczytuje wcześniejszą historię wiadomości rozmowy widżetu, na przykład po ponownym wczytaniu strony.POST /api/public/widget/pollPobiera wiadomości otrzymane po określonym momencie — na przykład odpowiedź pracownika, który przejął rozmowę.POST /api/public/widget/ratingZapisuje ocenę odwiedzającego dotyczącą rozmowy (pomocna lub niepomocna).POST /api/public/widget/trackRejestruje anonimowe zdarzenie użycia widżetu (np. „widżet otwarty”) na potrzeby analiz w panelu.POST /api/public/widget/voice-transcribeZamienia nagranie głosowe odwiedzającego na tekst (wprowadzanie głosowe), jeśli funkcja głosowa jest aktywowana dla widżetu.

Powiązane artykuły

← Widżet czatu