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

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

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

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

پیرامیٹرز

widget_code(query, string، ضروری)— آپ کے ایمبیڈ کوڈ سے ویجٹ کوڈ
session_id(query, string، ضروری)— گفتگو کا سیشن آئی ڈی `message` کے جواب سے
visitor_id(query, string، ضروری)— وزیٹر آئی ڈی جو ویجٹ تیار کرتا ہے اور براؤزر میں محفوظ کرتا ہے

مثالی Response

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

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

← چیٹ ویجٹ