POST/api/public/widget/voice-transcribe

Konverterer en besøkendes taleopptak til tekst (taleinnput), hvis talefunksjonen er aktivert for widgeten.

Send `widget_code` og lyddata i feltet `audio` som `multipart/form-data`. Svaret inneholder den gjenkjente teksten, som du deretter sender via `POST /api/public/widget/message`. Hvorvidt talefunksjonen er aktiv, vises av `voice_enabled` i widget-konfigurasjonen. Mangler `widget_code`, svarer serveren med 400 `WIDGET_CODE_REQUIRED`; er talefunksjonen ikke aktivert eller for øyeblikket ikke tilgjengelig, med 503 `VOICE_UNAVAILABLE`. Zentor setter opp talefunksjonen for widgeten din.

Oversikt

Kall: POST /api/public/widget/voice-transcribe. Endepunktet tilhører gruppen «Chat-widget» i API-et til Zentor App. Det krever et gyldig widget-innbyggingstoken. Kallet er ikke idempotent: Hvert vellykket kall utløser handlingen på nytt. Obligatoriske parametere: widget_code (body), audio (body). Dokumenterte feiltilfeller: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. Eksempelsvaret nedenfor viser strukturen til et vellykket svar i JSON-format.

Autentisering og sikring

Widget-embed-token (header X-Widget-Token) + godkjenningsliste for origins

Idempotent: Nei

Parametere

widget_code(body, string, påkrevd)— Widget-kode fra innbyggingskoden din
audio(body, binary, påkrevd)— Lydopptak som fil (`multipart/form-data`)

Eksempel på svar

{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Talefunksjonen er for øyeblikket ikke tilgjengelig."}}

Feilkoder

400 WIDGET_CODE_REQUIRED — Feltet `widget_code` mangler.
503 VOICE_UNAVAILABLE — Talefunksjonen er ikke aktivert for denne widgeten eller er for øyeblikket ikke tilgjengelig.

Verifisert oppførsel

En manglende `widget_code` returnerer 400 `WIDGET_CODE_REQUIRED`, en widget uten talefunksjon 503 `VOICE_UNAVAILABLE`. Suksesstilfellet forutsetter en widget med aktivert talefunksjon.

Chat-widget

GET /api/public/widget/healthEnkel tilgjengelighetskontroll av widget-tjenesten.GET /api/public/widget/config/:widget_codeReturnerer en widgets offentlige konfigurasjon (visningsnavn, velkomsttekst, design, språk, talefunksjon) for initialisering i nettleseren.POST /api/public/widget/messageSender en besøkendes melding til chatboten og returnerer svaret – chat-widgetens sentrale endepunkt.GET /api/public/widget/historyLaster den tidligere meldingshistorikken til en widget-samtale, for eksempel etter at siden er lastet på nytt.POST /api/public/widget/pollHenter meldinger som er mottatt etter et gitt tidspunkt – for eksempel svaret fra en ansatt som har tatt over samtalen.POST /api/public/widget/ratingLagrer den besøkendes vurdering av en samtale (nyttig eller ikke nyttig).POST /api/public/widget/trackRegistrerer en anonym widget-brukshendelse (f.eks. «widget åpnet») for analysene i dashbordet.POST /api/public/widget/voice-speakKonverterer tekst til tale (taleutgang i widgeten), hvis talefunksjonen er aktivert.

Relaterte artikler

← Chat-widget