POST/api/public/widget/message

Ithumela umlayezo wesivakashi ku-chatbot futhi inikeze impendulo yayo – isiphetho esimaphakathi sewijethi yengxoxo.

Dlulisani `widget_code`, `message`, `visitor_id` futhi – kusukela kumlayezo wesibili – `session_id` ovela empendulweni edlule. Uma nibiza kokuqala ingxoxo entsha, shiyani `session_id` ingenalutho noma iyihlele ngo-`null`. Impendulo iqukethe kwisakhiwo `data` i-`session_id`, umbhalo wempendulo `response`, kanye nokunye uma kudingeka izinkinobho (`buttons`), iziphakamiso zemikhiqizo (`products`) nesimo sengxoxo (`state`). I-header `X-Widget-Token` enethokheni yokufaka ne-`widget_code` kudingekile. Uma ithokheni ingekho, iseva isabela ngo-401 `WIDGET_TOKEN_MISSING`, uma ingavumeleki ngo-401 `WIDGET_TOKEN_INVALID`; izicelo ezivela ezizindeni ezingavuliwe zithola 403 `WIDGET_ORIGIN_DENIED`, iwijethi evalwe 404 `WIDGET_DISABLED`. Uma `visitor_id` ingekho, iseva isabela ngo-400 `VISITOR_ID_REQUIRED`. Isicelo asilingananisi: ukuthumela ngakunye kudala umlayezo omusha wesivakashi nempendulo enye futhi. Valani ukufaka ngesikhathi isicelo siqhubeka, futhi ningasiphindi ngokuzenzakalela.

Ukubuka konke

Ukubiza: POST /api/public/widget/message. Le endpoint ingeyeqembu elithi “Iwijethi yengxoxo” le-API ye-Zentor App. Idinga i-widget embed token evumelekile. Ukubiza akuyona i-idempotent: ukubiza ngakunye okuphumelelayo kuqalisa isenzo kabusha. Amapharamitha ayimpoqo: widget_code (body), message (body), visitor_id (body). Amapharamitha ongawakhetha: session_id (body). Izimo zamaphutha ezibhaliwe: 401 WIDGET_TOKEN_MISSING, 401 WIDGET_TOKEN_INVALID, 400 VISITOR_ID_REQUIRED. Isibonelo sempendulo ngezansi sibonisa ukwakheka kwempendulo ephumelelayo ngefomethi ye-JSON.

Ukuqinisekisa ubunikazi nokuvikeleka

I-widget embed token (i-header X-Widget-Token) + uhlu lwama-origin avunyelwe

I-idempotent: Cha

Amapharamitha

widget_code(body, string, kuyadingeka)— Ikhodi yewijethi evela ekhodini yakho yokufaka
message(body, string, kuyadingeka)— Umbhalo womlayezo wesivakashi
visitor_id(body, string, kuyadingeka)— I-ID yesivakashi edalwa yewijethi futhi igcinwe ebhrawuzeni
session_id(body, string)— I-ID yeseshini evela empendulweni edlule; ekubizeni kokuqala ingxoxo entsha ingenalutho noma `null`

Isibonelo se-request

{"widget_code":"...","message":"Sawubona, i-Zentor App ingenzani?","visitor_id":"<UUID noma i-ID eyenziwe yiklayenti>"}

Isibonelo se-response

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

Amakhodi amaphutha

401 WIDGET_TOKEN_MISSING — Iheda `X-Widget-Token` ayikho.
401 WIDGET_TOKEN_INVALID — Ithokheni yokufaka ayihambisani nekhodi yewijethi.
400 VISITOR_ID_REQUIRED — Insimu `visitor_id` ayikho.

Ukuziphatha okuhlolwe

Umlayezo osemthethweni unikeza 200 nempendulo ye-chatbot; ithokheni engekho noma engavumeleki kanye ne-`visitor_id` engekho zinikeza amakhodi wamaphutha abhaliwe.

Iwijethi yengxoxo

GET /api/public/widget/healthUkuhlolwa okulula kokutholakala kwesevisi yewijethi.GET /api/public/widget/config/:widget_codeInikeza ukuhlelwa komphakathi kwewijethi (igama lokubonisa, umbhalo wokubingelela, idizayini, ulimi, umsebenzi wezwi) wokuqaliswa kwebhrawuza.GET /api/public/widget/historyIlayisha umlando wemiyalezo eyisekhona wengxoxo yewijethi, isibonelo ngemva kokulayishwa kabusha kwekhasi.POST /api/public/widget/pollIlanda imiyalezo eyamukelwe ngemva kwesikhathi esithile – isibonelo impendulo yesisebenzi esithatha ingxoxo.POST /api/public/widget/ratingIgcina ukulinganiswa kwesivakashi mayelana nengxoxo (kusiza noma akusizi).POST /api/public/widget/trackIrekhoda isenzakalo esingaziwa sokusetshenziswa kwewijethi (isib. „iwijethi ivuliwe“) sokuhlaziywa kwedashboard.POST /api/public/widget/voice-transcribeIguqula ukuqoshwa kwezwi kwesivakashi kube umbhalo (ukufakwa kwezwi), uma umsebenzi wezwi wewijethi uvuliwe.POST /api/public/widget/voice-speakIguqula umbhalo kube ulimi olukhulunywayo (ukukhiphwa kwezwi ewijethini), uma umsebenzi wezwi uvuliwe.

Izihloko ezihlobene

← Iwijethi yengxoxo