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 فارمیٹ میں کامیاب جواب کی ساخت دکھاتا ہے۔

تصدیقِ شناخت اور تحفظ

ویجیٹ ایمبیڈ ٹوکن (ہیڈر X-Widget-Token) + Origin کی منظوری کی فہرست

Idempotent (دہرانے پر یکساں اثر): جی ہاں

پیرامیٹرز

widget_code(body, string، ضروری)— آپ کے ایمبیڈ کوڈ سے ویجٹ کوڈ
text(body, string، ضروری)— وہ متن جو پڑھنا ہے

مثالی Response

{"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وزیٹر کی صوتی ریکارڈنگ کو متن میں تبدیل کرتا ہے (صوتی ان پٹ)، بشرطیکہ آواز کی سہولت ویجٹ کے لیے فعال ہو۔

متعلقہ مضامین

← چیٹ ویجٹ