POST/api/public/widget/message
பார்வையாளரின் செய்தியை சாட்பாட்டிற்கு அனுப்பி அதன் பதிலைத் திருப்பி அளிக்கிறது – அரட்டை விட்ஜெட்டின் மைய முடிவுப்புள்ளி.
`widget_code`, `message`, `visitor_id` மற்றும் – இரண்டாவது செய்தியிலிருந்து – முந்தைய பதிலிலிருந்து `session_id`-ஐ அனுப்பவும். புதிய உரையாடலின் முதல் அழைப்பில் `session_id`-ஐ வெறுமையாக விடுங்கள் அல்லது `null` எனக் குறிக்கவும். பதிலில் `data` பொருளில் `session_id`, பதில் உரை `response`, தேவைப்பட்டால் பொத்தான்கள் (`buttons`), தயாரிப்பு பரிந்துரைகள் (`products`) மற்றும் உரையாடல் நிலை (`state`) அடங்கும். `X-Widget-Token` தலைப்பு உட்பொதிப்பு டோக்கனுடனும் `widget_code`-உடனும் தேவை. டோக்கன் இல்லையெனில் சர்வர் 401 `WIDGET_TOKEN_MISSING`, தவறானால் 401 `WIDGET_TOKEN_INVALID` எனப் பதிலளிக்கும்; அனுமதிக்கப்படாத டொமைன்களிலிருந்து அழைப்புகள் 403 `WIDGET_ORIGIN_DENIED`, முடக்கப்பட்ட விட்ஜெட் 404 `WIDGET_DISABLED` பெறும். `visitor_id` இல்லையெனில் சர்வர் 400 `VISITOR_ID_REQUIRED` எனப் பதிலளிக்கும். இந்த அழைப்பு idempotent அல்ல: ஒவ்வொரு அனுப்புதலும் மேலும் ஒரு பார்வையாளர் செய்தியையும் மேலும் ஒரு பதிலையும் உருவாக்கும். ஒரு கோரிக்கை நடைபெறும்போது உள்ளீட்டைப் பூட்டி வையுங்கள், தானாக மீண்டும் முயற்சிக்காதீர்கள்.
கண்ணோட்டம்
அழைப்பு: POST /api/public/widget/message. இந்த எண்ட்பாயிண்ட் Zentor App API-யின் “அரட்டை விட்ஜெட்” குழுவைச் சேர்ந்தது. இதற்குச் செல்லுபடியான விட்ஜெட் எம்பெட் டோக்கன் தேவை. இந்த அழைப்பு idempotent அல்ல: ஒவ்வொரு வெற்றிகரமான அழைப்பும் செயலை மீண்டும் தூண்டும். கட்டாய அளவுருக்கள்: widget_code (பாடி), message (பாடி), visitor_id (பாடி). விருப்ப அளவுருக்கள்: session_id (பாடி). ஆவணப்படுத்தப்பட்ட பிழை நிலைகள்: 401 WIDGET_TOKEN_MISSING, 401 WIDGET_TOKEN_INVALID, 400 VISITOR_ID_REQUIRED. கீழே உள்ள மாதிரி பதில், JSON வடிவில் வெற்றிகரமான பதிலின் கட்டமைப்பைக் காட்டுகிறது.
அங்கீகாரம் & பாதுகாப்பு
Widget-Embed-Token (Header X-Widget-Token) + Origin அனுமதிப் பட்டியல்
Idempotent (மீண்டும் செய்தாலும் அதே விளைவு): இல்லை
அளவுருக்கள்
widget_code(body, string, கட்டாயம்)— உங்கள் உட்பொதிப்புக் குறியீட்டிலிருந்து விட்ஜெட் குறியீடுmessage(body, string, கட்டாயம்)— பார்வையாளர் செய்தியின் உரைvisitor_id(body, string, கட்டாயம்)— விட்ஜெட் உருவாக்கி உலாவியில் சேமிக்கும் பார்வையாளர் அடையாளம்session_id(body, string)— முந்தைய பதிலிலிருந்து அமர்வு அடையாளம்; புதிய உரையாடலின் முதல் அழைப்பில் வெற்று அல்லது `null`எடுத்துக்காட்டுக் கோரிக்கை
{"widget_code":"...","message":"வணக்கம், Zentor App என்ன செய்ய முடியும்?","visitor_id":"<UUID அல்லது கிளையன்ட் பக்கத்தில் உருவாக்கப்பட்ட ID>"}எடுத்துக்காட்டுப் பதில்
{"ok":true,"data":{"session_id":"31b1096c-a366-4418-b4be-bd999ff98134","response":"...","buttons":[],"state":"idle","products":[]}}பிழைக் குறியீடுகள்
401 WIDGET_TOKEN_MISSING — `X-Widget-Token` தலைப்பு இல்லை.401 WIDGET_TOKEN_INVALID — உட்பொதிப்பு டோக்கன் விட்ஜெட் குறியீட்டுடன் பொருந்தவில்லை.400 VISITOR_ID_REQUIRED — `visitor_id` புலம் இல்லை.சரிபார்க்கப்பட்ட நடத்தை
சரியான செய்தி சாட்பாட்டின் பதிலுடன் 200-ஐத் திருப்பி அளிக்கிறது; காணாமல்போன அல்லது தவறான டோக்கன் மற்றும் காணாமல்போன `visitor_id` ஆகியவை ஆவணப்படுத்தப்பட்ட பிழைக் குறியீடுகளைத் திருப்பி அளிக்கும்.
அரட்டை விட்ஜெட்
GET /api/public/widget/healthவிட்ஜெட் சேவையின் எளிய கிடைக்கும் தன்மைச் சோதனை.GET /api/public/widget/config/:widget_codeஉலாவியில் தொடக்கத்திற்காக ஒரு விட்ஜெட்டின் பொது உள்ளமைவை (காட்சிப் பெயர், வரவேற்புச் செய்தி, வடிவமைப்பு, மொழி, குரல் வசதி) தருகிறது.GET /api/public/widget/historyபக்கம் மீண்டும் ஏற்றப்பட்ட பிறகு போன்ற நேரங்களில் விட்ஜெட் உரையாடலின் முந்தைய செய்தி வரலாற்றை ஏற்றுகிறது.POST /api/public/widget/pollஒரு குறிப்பிட்ட நேரத்திற்குப் பிறகு பெறப்பட்ட செய்திகளைப் பெறுகிறது – எடுத்துக்காட்டாக உரையாடலை எடுத்துக்கொண்ட ஊழியரின் பதில்.POST /api/public/widget/ratingஒரு உரையாடலுக்கான பார்வையாளரின் மதிப்பீட்டைச் சேமிக்கிறது (பயனுள்ளது அல்லது பயனுள்ளதாக இல்லை).POST /api/public/widget/trackடாஷ்போர்டு பகுப்பாய்வுகளுக்காக விட்ஜெட்டின் அநாமதேய பயன்பாட்டு நிகழ்வை (எடுத்துக்காட்டாக "விட்ஜெட் திறக்கப்பட்டது") பதிவு செய்கிறது.POST /api/public/widget/voice-transcribeவிட்ஜெட்டிற்கு குரல் அம்சம் இயக்கப்பட்டிருந்தால், பார்வையாளரின் குரல் பதிவை உரையாக மாற்றுகிறது (குரல் உள்ளீடு).POST /api/public/widget/voice-speakகுரல் அம்சம் இயக்கப்பட்டிருந்தால், உரையை பேச்சாக மாற்றுகிறது (விட்ஜெட்டில் குரல் வெளியீடு).