POST/api/public/widget/voice-transcribe

Verander 'n stemopname van die besoeker in teks (spraakinvoer), indien die spraakfunksie vir die widget geaktiveer is.

Stuur `widget_code` en die klankdata in die veld `audio` as `multipart/form-data`. Die antwoord bevat die herkende teks, wat u daarna via `POST /api/public/widget/message` stuur. Of die spraakfunksie aktief is, wys `voice_enabled` in die widget-konfigurasie. Ontbreek `widget_code`, antwoord die bediener met 400 `WIDGET_CODE_REQUIRED`; is die spraakfunksie nie geaktiveer of tans nie beskikbaar nie, met 503 `VOICE_UNAVAILABLE`. Die spraakfunksie word deur Zentor vir u widget opgestel.

Oorsig

Oproep: POST /api/public/widget/voice-transcribe. Hierdie eindpunt behoort tot die groep “Chat-widget” van die Zentor App-API. Dit vereis ’n geldige widget-inbedtoken. Die oproep is nie idempotent nie: elke suksesvolle oproep aktiveer die aksie opnuut. Verpligte parameters: widget_code (body), audio (body). Gedokumenteerde foutgevalle: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. Die voorbeeldrespons hieronder toon die struktuur van ’n suksesvolle respons in JSON-formaat.

Verifikasie en sekuriteit

Widget-inbedtoken (X-Widget-Token-header) + lys van toegelate origins

Idempotent: Nee

Parameters

widget_code(body, string, vereis)— Widget-kode uit u inbedkode
audio(body, binary, vereis)— Klankopname as lêer (`multipart/form-data`)

Voorbeeldrespons

{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Sprachfunktion aktuell nicht verfügbar."}}

Foutkodes

400 WIDGET_CODE_REQUIRED — Die veld `widget_code` ontbreek.
503 VOICE_UNAVAILABLE — Die spraakfunksie is nie vir hierdie widget geaktiveer nie of tans nie beskikbaar nie.

Gekontroleerde gedrag

'n Ontbrekende `widget_code` lewer 400 `WIDGET_CODE_REQUIRED`, 'n widget sonder spraakfunksie 503 `VOICE_UNAVAILABLE`. Die suksesgeval veronderstel 'n widget met geaktiveerde spraakfunksie.

Chat-widget

GET /api/public/widget/healthEenvoudige bereikbaarheidstoets van die widget-diens.GET /api/public/widget/config/:widget_codeLewer die openbare konfigurasie van 'n widget (vertoonnaam, verwelkomingsteks, ontwerp, taal, spraakfunksie) vir die inisialisering in die blaaier.POST /api/public/widget/messageStuur 'n boodskap van die besoeker aan die kletsbot en lewer sy antwoord – die sentrale endpunt van die kletswidget.GET /api/public/widget/historyLaai die bestaande boodskapgeskiedenis van 'n widget-konversasie, byvoorbeeld na die herlaai van die bladsy.POST /api/public/widget/pollHaal boodskappe op wat ná 'n tydstip ontvang is – byvoorbeeld die antwoord van 'n personeellid wat die gesprek oorgeneem het.POST /api/public/widget/ratingStoor die beoordeling van die besoeker oor 'n konversasie (nuttig of nie nuttig nie).POST /api/public/widget/trackRegistreer 'n anonieme gebruiksgebeurtenis van die widget (bv. „widget geopen“) vir die evaluasies in die kontrolepaneel.POST /api/public/widget/voice-speakVerander teks in gesproke taal (spraakuitvoer in die widget), indien die spraakfunksie geaktiveer is.

Verwante artikels

← Chat-widget