GET/api/public/widget/history
பக்கம் மீண்டும் ஏற்றப்பட்ட பிறகு போன்ற நேரங்களில் விட்ஜெட் உரையாடலின் முந்தைய செய்தி வரலாற்றை ஏற்றுகிறது.
`widget_code`, `session_id`, `visitor_id` ஆகியவற்றை வினவல் அளவுருக்களாக அனுப்பவும். பதிலில் `data` பொருளில் `messages` பட்டியல் உள்ளது, இதில் `role` (`user` அல்லது `assistant`), `text`, `created_at` உரையாடல் வரிசையில் அடங்கும். இந்த அழைப்பு முற்றிலும் படிக்க மட்டுமே மற்றும் idempotent ஆகும். `X-Widget-Token` தலைப்பு உட்பொதிப்பு டோக்கனுடனும் `widget_code`-உடனும் தேவை. டோக்கன் இல்லையெனில் சர்வர் 401 `WIDGET_TOKEN_MISSING`, தவறானால் 401 `WIDGET_TOKEN_INVALID` எனப் பதிலளிக்கும்; அனுமதிக்கப்படாத டொமைன்களிலிருந்து அழைப்புகள் 403 `WIDGET_ORIGIN_DENIED`, முடக்கப்பட்ட விட்ஜெட் 404 `WIDGET_DISABLED` பெறும். `session_id` அல்லது `visitor_id` இல்லையெனில் சர்வர் 400 `PARAMS_REQUIRED` எனப் பதிலளிக்கும். அமர்வு இனி அறியப்படவில்லை எனில், புதிய உரையாடலைத் தொடங்குங்கள்.
கண்ணோட்டம்
அழைப்பு: GET /api/public/widget/history. இந்த எண்ட்பாயிண்ட் Zentor App API-யின் “அரட்டை விட்ஜெட்” குழுவைச் சேர்ந்தது. இதற்குச் செல்லுபடியான விட்ஜெட் எம்பெட் டோக்கன் தேவை. இந்த அழைப்பு idempotent ஆகும்: அதே உள்ளீடுகளுடன் மீண்டும் மீண்டும் அழைத்தால் அதே முடிவு கிடைக்கும். கட்டாய அளவுருக்கள்: widget_code (குவெரி), session_id (குவெரி), visitor_id (குவெரி). ஆவணப்படுத்தப்பட்ட பிழை நிலைகள்: 400 PARAMS_REQUIRED. கீழே உள்ள மாதிரி பதில், JSON வடிவில் வெற்றிகரமான பதிலின் கட்டமைப்பைக் காட்டுகிறது.
அங்கீகாரம் & பாதுகாப்பு
Widget-Embed-Token (Header X-Widget-Token) + Origin அனுமதிப் பட்டியல்
Idempotent (மீண்டும் செய்தாலும் அதே விளைவு): ஆம்
அளவுருக்கள்
widget_code(query, string, கட்டாயம்)— உங்கள் உட்பொதிப்புக் குறியீட்டிலிருந்து விட்ஜெட் குறியீடுsession_id(query, string, கட்டாயம்)— `message` பதிலிலிருந்து உரையாடலின் அமர்வு அடையாளம்visitor_id(query, string, கட்டாயம்)— விட்ஜெட் உருவாக்கி உலாவியில் சேமிக்கும் பார்வையாளர் அடையாளம்எடுத்துக்காட்டுப் பதில்
{"ok":true,"data":{"messages":[{"role":"user","text":"வணக்கம்...","created_at":"..."},{"role":"assistant","text":"...","created_at":"..."}]}}பிழைக் குறியீடுகள்
400 PARAMS_REQUIRED — `session_id` அல்லது `visitor_id` இல்லை.சரிபார்க்கப்பட்ட நடத்தை
ஏற்கனவே உள்ள அமர்வு செய்தி வரலாற்றுடன் 200-ஐத் திருப்பி அளிக்கிறது; காணாமல்போன அளவுருக்கள் 400 `PARAMS_REQUIRED`-ஐத் திருப்பி அளிக்கும்.
அரட்டை விட்ஜெட்
GET /api/public/widget/healthவிட்ஜெட் சேவையின் எளிய கிடைக்கும் தன்மைச் சோதனை.GET /api/public/widget/config/:widget_codeஉலாவியில் தொடக்கத்திற்காக ஒரு விட்ஜெட்டின் பொது உள்ளமைவை (காட்சிப் பெயர், வரவேற்புச் செய்தி, வடிவமைப்பு, மொழி, குரல் வசதி) தருகிறது.POST /api/public/widget/messageபார்வையாளரின் செய்தியை சாட்பாட்டிற்கு அனுப்பி அதன் பதிலைத் திருப்பி அளிக்கிறது – அரட்டை விட்ஜெட்டின் மைய முடிவுப்புள்ளி.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குரல் அம்சம் இயக்கப்பட்டிருந்தால், உரையை பேச்சாக மாற்றுகிறது (விட்ஜெட்டில் குரல் வெளியீடு).