POST/api/global-chatbot/demo/poll
ڈیمو چیٹ سیشن کے نئے، غیر ہم وقت طور پر آنے والے پیغامات دریافت کرتا ہے (مثلاً جب ماسٹر ایڈمن میں کسی انسانی ایجنٹ نے سنبھال لیا ہو) — ویجیٹ اسے وقفے وقفے سے کال کرتا ہے۔
`POST /api/global-chatbot/demo/poll` موجودہ ڈیمو سیشن کے لیے نئے پیغامات یا اسٹیٹس کی تبدیلیوں کی جانچ کرتا ہے۔ Body میں `session_id` اور `visitor_id` شامل ہوتے ہیں۔ دونوں ویلیوز ایک ہی عوامی ڈیمو گفتگو سے آنی چاہییں۔ اگر کوئی ایک پیرامیٹر موجود نہ ہو تو سرور `400 PARAMS_REQUIRED` کے ساتھ جواب دیتا ہے۔ یہ روٹ صارف لاگ ان نہیں مانگتا اور ڈیمو سیشن کی موجودہ حالت پڑھتا ہے۔ اسے تب استعمال کیا جاتا ہے جب کوئی جواب پچھلی درخواست کے ساتھ فوراً واپس نہ آئے یا جب انٹرفیس کو بعد میں آنے والے پیغامات دکھانے ہوں۔ Polling پیغام بھیجنے کا متبادل نہیں ہے؛ یہ خود کوئی نئی وزیٹر انکوائری پیدا نہیں کرتا۔ کلائنٹ کو کالز کے درمیان مناسب وقفہ رکھنا چاہیے۔ ایک تنگ لامتناہی لوپ لوڈ بڑھاتا ہے اور Rate-Limits کو متحرک کر سکتا ہے، بغیر اس کے کہ جواب جلد مل جائے۔ اگر سیشن ختم ہو جائے، غیر درست ہو جائے یا نہ ملے تو Polling رک جانا چاہیے اور انٹرفیس کو نیا آغاز پیش کرنا چاہیے۔ بند کیے گئے صفحات یا چھپے ہوئے ٹیبز کو مستقل چلتی پس منظر کی درخواستیں نہیں چھوڑنی چاہییں۔ `session_id` اور `visitor_id` دوسری گفتگو کے لیے عمومی رسائی کی معلومات نہیں ہیں۔ انہیں وزیٹرز کے درمیان شیئر نہیں کیا جانا چاہیے اور نہ ہی پیغامات کے ساتھ عوامی اینالیٹکس ٹولز کو بھیجا جانا چاہیے۔ ڈیمو ٹیننٹ گفتگو اور پروڈکشن ان باکس ڈیٹا سے الگ رہتا ہے۔ ایک درست ٹیسٹ ڈیمو سیشن شروع کرتا ہے، پیغام بھیجتا ہے اور پھر انہی شناخت کنندگان کے ساتھ Poll کو کال کرتا ہے۔ اس کے علاوہ `visitor_id` کے بغیر ایک درخواست جانچی جاتی ہے۔ دستاویزی منفی ٹیسٹ ایک غلطی کا ثبوت ہے، اس بات کا ثبوت نہیں کہ کوئی مکمل پروڈکشن گفتگو کامیابی سے مکمل ہوئی۔
تصدیقِ شناخت اور تحفظ
تصدیقِ شناخت ضروری نہیں
Idempotent (دہرانے پر یکساں اثر): جی ہاں
پیرامیٹرز
session_id(body, string، ضروری)visitor_id(body, string، ضروری)مثالی Request
{"session_id":"<UUID>","visitor_id":"<UUID>"}مثالی Response
{"ok":true,"data":{"messages":[]}}خرابی کے کوڈز
400 PARAMS_REQUIRED — session_id اور/یا visitor_id غائب ہیں۔لائیو ٹیسٹ کا ثبوت
کامیابی (200، خالی فہرست کیونکہ demo.chat کے بعد کوئی نئے غیر ہم وقت پیغامات نہیں آئے) اور منفی صورت (400) لائیو تصدیق شدہ۔