POST/api/public/widget/message

Inotumira meseji yemushanyi kuchatbot uye inopa mhinduro yayo – endpoint yepakati yewidget yehurukuro.

Tumirai `widget_code`, `message`, `visitor_id` uye – kubva pameseji yechipiri – `session_id` inobva pamhinduro yapfuura. Kana muchifonera kekutanga hurukuro itsva, sendai `session_id` isina chinhu kana ipei `null`. Mhinduro ine mukati mechinyorwa `data` `session_id`, mashoko emhinduro `response`, pamwe nezvimwe kana zvichidiwa mabhatani (`buttons`), zvinoratidzwa zvigadzirwa (`products`) nemamiriro ehurukuro (`state`). Heda `X-Widget-Token` ine tokheni yekuisa ne`widget_code` zvinodikanwa. Kana tokheni isipo, seva inopindura ne401 `WIDGET_TOKEN_MISSING`, kana isisiri yechokwadi ne401 `WIDGET_TOKEN_INVALID`; zvikumbiro zvinobva pamadomeni asina kuvhurwa zvinowana 403 `WIDGET_ORIGIN_DENIED`, widget yakavharwa 404 `WIDGET_DISABLED`. Kana `visitor_id` isipo, seva inopindura ne400 `VISITOR_ID_REQUIRED`. Chikumbiro hachina idempotency: kutumira kumwe nekumwe kunogadzira imwe meseji yemushanyi neimwe mhinduro. Vharai kuisa nguva chikumbiro chichiri kuenderera, uye musachidzokorora zvega.

Pfupiso

Kudana: POST /api/public/widget/message. Endpoint iyi ndeyeboka re“Chat widget” reAPI yeZentor App. Inoda widget embed token inoshanda. Kudana uku hakusi idempotent: kudana kwese kwese kunobudirira kunotangisa chiito zvakare. Maparameter anodiwa: widget_code (body), message (body), visitor_id (body). Maparameter ekusarudza: session_id (body). Zviitiko zvezvikanganiso zvakanyorwa: 401 WIDGET_TOKEN_MISSING, 401 WIDGET_TOKEN_INVALID, 400 VISITOR_ID_REQUIRED. Mhinduro yemuenzaniso iri pazasi inoratidza chimiro chemhinduro inobudirira muJSON format.

Kusimbiswa nekuchengetedza

Widget embed token (header X-Widget-Token) + rondedzero yeOrigin dzakabvumidzwa

Idempotent: Kwete

Maparameter

widget_code(body, string, zvinodiwa)— Kodhi yewidget inobva mukodhi yenyu yekuisa
message(body, string, zvinodiwa)— Zvinyorwa zvemeseji yemushanyi
visitor_id(body, string, zvinodiwa)— ID yemushanyi inogadzirwa newidget uye yakachengetwa mubhurauza
session_id(body, string)— ID yesesheni inobva pamhinduro yapfuura; pakufonera kekutanga hurukuro itsva isina chinhu kana `null`

Muenzaniso wechikumbiro

{"widget_code":"...","message":"Mhoro, Zentor App inogona kuitei?","visitor_id":"<UUID kana ID yakagadzirwa neclient>"}

Muenzaniso wemhinduro

{"ok":true,"data":{"session_id":"31b1096c-a366-4418-b4be-bd999ff98134","response":"...","buttons":[],"state":"idle","products":[]}}

Makodhi ekukanganisa

401 WIDGET_TOKEN_MISSING — Heda `X-Widget-Token` isipo.
401 WIDGET_TOKEN_INVALID — Tokheni yekuisa haifanani nekodhi yewidget.
400 VISITOR_ID_REQUIRED — Fiyedhi `visitor_id` isipo.

Mafambiro akaongororwa

Meseji yakanaka inopa 200 nemhinduro yechatbot; tokheni isipo kana isisiri yechokwadi pamwe ne-`visitor_id` isipo zvinopa makodhi ekukanganisa akanyorwa.

Chat widget

GET /api/public/widget/healthKuongorora kuwanikwa kwakareruka kwesevhisi yewidget.GET /api/public/widget/config/:widget_codeInopa kugadzirwa kweveruzhinji kwewidget (zita rinoratidzwa, mashoko ekugamuchira, dhizaini, mutauro, basa revhoiza) rekutanga mubhurauza.GET /api/public/widget/historyInorodha nhoroondo yemashoko ariko yehurukuro yewidget, semuenzaniso mushure mekureloadwa kwepeji.POST /api/public/widget/pollInotora mameseji akagamuchirwa mushure menguva yakati – semuenzaniso mhinduro yemushandi akatora hurukuro.POST /api/public/widget/ratingInochengetedza kuongorora kwemushanyi pamusoro pehurukuro (kunobatsira kana hakubatsiri).POST /api/public/widget/trackInonyora chiitiko chekushandiswa chisingazivikanwi chewidget (semuenzaniso „widget yavhurwa“) kuongororo yedashboard.POST /api/public/widget/voice-transcribeInoshandura rekodhi yezwi remushanyi kuita zvinyorwa (kuisa nezwi), kana basa rezwi rewidget rakavhurwa.POST /api/public/widget/voice-speakInoshandura zvinyorwa kuita mutauro unotaurwa (kubuda kwezwi muwidget), kana basa rezwi rakavhurwa.

Zvinyorwa zvine hukama

← Chat widget