POST/api/public/widget/voice-speak

Konverterar text till tal (röstutmatning i widgeten), om röstfunktionen är aktiverad.

Skicka `widget_code` och texten som ska läsas upp i `text`. Svaret innehåller ljuddata för uppspelning i webbläsaren. För direkt uppspelning via ett `<audio>`-element är samma sökväg dessutom tillgänglig via GET. Saknas `widget_code` svarar servern med 400 `WIDGET_CODE_REQUIRED`; är röstfunktionen inte aktiverad eller för tillfället inte tillgänglig, med 503 `VOICE_UNAVAILABLE`. Starta en ny uppspelning först när den föregående har avslutats.

Översikt

Anrop: POST /api/public/widget/voice-speak. Endpointen tillhör gruppen ”Chattwidget” i Zentor Apps API. Den kräver en giltig widget-inbäddningstoken. Anropet är idempotent: Upprepade anrop med samma uppgifter ger samma resultat. Obligatoriska parametrar: widget_code (body), text (body). Dokumenterade felfall: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. Exempelsvaret nedan visar strukturen för ett lyckat svar i JSON-format.

Autentisering & säkerhet

Widget-embed-token (header X-Widget-Token) + lista över godkända origins

Idempotent: Ja

Parametrar

widget_code(body, string, obligatorisk)— Widget-kod från din inbäddningskod
text(body, string, obligatorisk)— Text som ska läsas upp

Exempel på response

{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Talfunktionen är för närvarande inte tillgänglig."}}

Felkoder

400 WIDGET_CODE_REQUIRED — Fältet `widget_code` saknas.
503 VOICE_UNAVAILABLE — Röstfunktionen är inte aktiverad för denna widget eller är för tillfället inte tillgänglig.

Verifierat beteende

En saknad `widget_code` returnerar 400 `WIDGET_CODE_REQUIRED`, en widget utan röstfunktion 503 `VOICE_UNAVAILABLE`. Framgångsfallet förutsätter en widget med aktiverad röstfunktion.

Chattwidget

GET /api/public/widget/healthEnkel tillgänglighetskontroll av widget-tjänsten.GET /api/public/widget/config/:widget_codeReturnerar en widgets offentliga konfiguration (visningsnamn, välkomsttext, design, språk, röstfunktion) för initiering i webbläsaren.POST /api/public/widget/messageSkickar en besökares meddelande till chattboten och returnerar dess svar – chattwidgetens centrala slutpunkt.GET /api/public/widget/historyLaddar den tidigare meddelandehistoriken för ett widget-samtal, till exempel efter att sidan har laddats om.POST /api/public/widget/pollHämtar meddelanden som mottagits efter en viss tidpunkt – till exempel svaret från en medarbetare som har tagit över samtalet.POST /api/public/widget/ratingSparar besökarens omdöme om ett samtal (hjälpsamt eller inte hjälpsamt).POST /api/public/widget/trackRegistrerar en anonym widget-användningshändelse (t.ex. ”widget öppnad”) för analyserna i kontrollpanelen).POST /api/public/widget/voice-transcribeKonverterar en besökares röstinspelning till text (röstinmatning), om röstfunktionen är aktiverad för widgeten.

Relaterade artiklar

← Chattwidget