POST/api/public/widget/voice-transcribe

Zet een spraakopname van de bezoeker om in tekst (spraakinvoer), als de spraakfunctie voor de widget is geactiveerd.

Stuur `widget_code` en de audiogegevens in het veld `audio` als `multipart/form-data`. Het antwoord bevat de herkende tekst, die u vervolgens via `POST /api/public/widget/message` verstuurt. Of de spraakfunctie actief is, blijkt uit `voice_enabled` in de widgetconfiguratie. Ontbreekt `widget_code`, dan antwoordt de server met 400 `WIDGET_CODE_REQUIRED`; is de spraakfunctie niet geactiveerd of momenteel niet beschikbaar, met 503 `VOICE_UNAVAILABLE`. Zentor richt de spraakfunctie voor uw widget in.

Overzicht

Aanroep: POST /api/public/widget/voice-transcribe. Dit endpoint hoort bij de groep ‘Chatwidget’ van de API van Zentor App. Het vereist een geldig widget-embedtoken. De aanroep is niet idempotent: elke geslaagde aanroep activeert de actie opnieuw. Verplichte parameters: widget_code (body), audio (body). Gedocumenteerde foutgevallen: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. Het voorbeeldantwoord hieronder toont de opbouw van een geslaagd antwoord in JSON-formaat.

Auth & beveiliging

Widget-embed-token (header X-Widget-Token) + origin-toestemmingslijst

Idempotent: Nee

Parameters

widget_code(body, string, vereist)— Widgetcode uit uw embedcode
audio(body, binary, vereist)— Audio-opname als bestand (`multipart/form-data`)

Voorbeeld-response

{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"De spraakfunctie is momenteel niet beschikbaar."}}

Foutcodes

400 WIDGET_CODE_REQUIRED — Het veld `widget_code` ontbreekt.
503 VOICE_UNAVAILABLE — De spraakfunctie is niet geactiveerd voor deze widget of momenteel niet beschikbaar.

Geverifieerd gedrag

Een ontbrekende `widget_code` geeft 400 `WIDGET_CODE_REQUIRED`, een widget zonder spraakfunctie 503 `VOICE_UNAVAILABLE`. Het succesgeval vereist een widget met geactiveerde spraakfunctie.

Chatwidget

GET /api/public/widget/healthEenvoudige bereikbaarheidscontrole van de widgetservice.GET /api/public/widget/config/:widget_codeGeeft de publieke configuratie van een widget (weergavenaam, welkomsttekst, vormgeving, taal, spraakfunctie) voor initialisatie in de browser.POST /api/public/widget/messageStuurt een bericht van de bezoeker naar de chatbot en geeft diens antwoord terug — het centrale endpoint van de chatwidget.GET /api/public/widget/historyLaadt de eerdere berichtgeschiedenis van een widgetgesprek, bijvoorbeeld na het opnieuw laden van de pagina.POST /api/public/widget/pollHaalt berichten op die na een bepaald tijdstip zijn ontvangen — bijvoorbeeld het antwoord van een medewerker die het gesprek heeft overgenomen.POST /api/public/widget/ratingSlaat de beoordeling van de bezoeker over een gesprek op (nuttig of niet nuttig).POST /api/public/widget/trackRegistreert een anoniem gebruiksevent van de widget (bijv. “widget geopend”) voor de analyses in het dashboard.POST /api/public/widget/voice-speakZet tekst om in gesproken taal (spraakuitvoer in de widget), als de spraakfunctie is geactiveerd.

Gerelateerde artikelen

← Chatwidget