Chatwidget

Alle endpoints die de ingesloten chatwidget op uw website gebruikt.

De chatwidget bindt uw chatbot in uw website in. Deze groep beschrijft alle endpoints die de widget gebruikt: beschikbaarheidscontrole, openbare widgetconfiguratie, berichten verzenden, gespreksgeschiedenis, nieuwe berichten ophalen (bijvoorbeeld na overname door een medewerker), beoordeling, gebruiksgebeurtenissen en spraakinvoer en -uitvoer.

`health` en `config` zijn toegankelijk zonder authenticatie, zodat de widget zich in de browser kan initialiseren. Alle overige endpoints verwachten de `widget_code` en het embed-token van de widget in de header `X-Widget-Token`. Zentor maakt de widget aan tijdens de inrichting, legt de goedgekeurde domeinen vast en levert u de insluitcode met widgetcode en embed-token. De server weigert aanroepen vanaf niet-goedgekeurde domeinen met 403 `WIDGET_ORIGIN_DENIED` en beantwoordt aanroepen voor een gedeactiveerde widget met 404 `WIDGET_DISABLED`.

Daarnaast gelden de toegangsregels van uw account (IP-, land- en domeinregels). `message` is niet idempotent: elke herhaalde verzending creëert een nieuw bericht en een nieuw antwoord.

GET/api/public/widget/healthGET/api/public/widget/config/:widget_codePOST/api/public/widget/messageGET/api/public/widget/historyPOST/api/public/widget/pollPOST/api/public/widget/ratingPOST/api/public/widget/trackPOST/api/public/widget/voice-transcribePOST/api/public/widget/voice-speak
← API-referentie