POST/api/public/widget/voice-speak
குரல் அம்சம் இயக்கப்பட்டிருந்தால், உரையை பேச்சாக மாற்றுகிறது (விட்ஜெட்டில் குரல் வெளியீடு).
`widget_code` மற்றும் படிக்கப்பட வேண்டிய உரையை `text`-இல் அனுப்பவும். பதிலில் உலாவியில் இயக்குவதற்கான ஆடியோ தரவு உள்ளது. `<audio>` உறுப்பு மூலம் நேரடியாக இயக்க, அதே பாதை GET மூலமாகவும் கூடுதலாகக் கிடைக்கும். `widget_code` இல்லையெனில் சர்வர் 400 `WIDGET_CODE_REQUIRED`, குரல் அம்சம் இயக்கப்படாவிட்டால் அல்லது தற்போது கிடைக்கவில்லை எனில் 503 `VOICE_UNAVAILABLE` எனப் பதிலளிக்கும். முந்தையது முடிந்த பிறகே புதிய இயக்கத்தைத் தொடங்குங்கள்.
கண்ணோட்டம்
அழைப்பு: POST /api/public/widget/voice-speak. இந்த எண்ட்பாயிண்ட் Zentor App API-யின் “அரட்டை விட்ஜெட்” குழுவைச் சேர்ந்தது. இதற்குச் செல்லுபடியான விட்ஜெட் எம்பெட் டோக்கன் தேவை. இந்த அழைப்பு idempotent ஆகும்: அதே உள்ளீடுகளுடன் மீண்டும் மீண்டும் அழைத்தால் அதே முடிவு கிடைக்கும். கட்டாய அளவுருக்கள்: widget_code (பாடி), text (பாடி). ஆவணப்படுத்தப்பட்ட பிழை நிலைகள்: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. கீழே உள்ள மாதிரி பதில், JSON வடிவில் வெற்றிகரமான பதிலின் கட்டமைப்பைக் காட்டுகிறது.
அங்கீகாரம் & பாதுகாப்பு
Widget-Embed-Token (Header X-Widget-Token) + Origin அனுமதிப் பட்டியல்
Idempotent (மீண்டும் செய்தாலும் அதே விளைவு): ஆம்
அளவுருக்கள்
widget_code(body, string, கட்டாயம்)— உங்கள் உட்பொதிப்புக் குறியீட்டிலிருந்து விட்ஜெட் குறியீடுtext(body, string, கட்டாயம்)— படிக்கப்பட வேண்டிய உரைஎடுத்துக்காட்டுப் பதில்
{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"குரல் வசதி தற்போது கிடைக்கவில்லை."}}பிழைக் குறியீடுகள்
400 WIDGET_CODE_REQUIRED — `widget_code` புலம் இல்லை.503 VOICE_UNAVAILABLE — குரல் அம்சம் இந்த விட்ஜெட்டிற்கு இயக்கப்படவில்லை அல்லது தற்போது கிடைக்கவில்லை.சரிபார்க்கப்பட்ட நடத்தை
காணாமல்போன `widget_code` 400 `WIDGET_CODE_REQUIRED`-ஐத் திருப்பி அளிக்கிறது, குரல் அம்சம் இல்லாத விட்ஜெட் 503 `VOICE_UNAVAILABLE`-ஐத் திருப்பி அளிக்கிறது. வெற்றி நிலைக்கு குரல் அம்சம் இயக்கப்பட்ட விட்ஜெட் தேவை.
அரட்டை விட்ஜெட்
GET /api/public/widget/healthவிட்ஜெட் சேவையின் எளிய கிடைக்கும் தன்மைச் சோதனை.GET /api/public/widget/config/:widget_codeஉலாவியில் தொடக்கத்திற்காக ஒரு விட்ஜெட்டின் பொது உள்ளமைவை (காட்சிப் பெயர், வரவேற்புச் செய்தி, வடிவமைப்பு, மொழி, குரல் வசதி) தருகிறது.POST /api/public/widget/messageபார்வையாளரின் செய்தியை சாட்பாட்டிற்கு அனுப்பி அதன் பதிலைத் திருப்பி அளிக்கிறது – அரட்டை விட்ஜெட்டின் மைய முடிவுப்புள்ளி.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விட்ஜெட்டிற்கு குரல் அம்சம் இயக்கப்பட்டிருந்தால், பார்வையாளரின் குரல் பதிவை உரையாக மாற்றுகிறது (குரல் உள்ளீடு).