JavaScript API

Respondo.init(config)#

ویجٹ کو شروع کر کے صفحے پر نصب کرتا ہے۔ ایک بار کال کرنا لازمی ہے۔ ویجٹ کا انسٹینس واپس کرتا ہے۔

const widget = Respondo.init({
  agentId: 'YOUR_AGENT_ID'
});

Respondo.identify(identity)#

موجودہ سیشن کے ساتھ صارف کی شناخت جوڑتا ہے۔ لاگ اِن کے بعد کال کریں۔

Respondo.identify({
  email: 'user@example.com',
  name: 'John Doe',
  userId: 'usr_123',
  userHash: 'hmac_sha256_signature', // optional, for identity verification
  metadata: { plan: 'pro' },
  properties: {                      // custom contact properties
    account_type: 'enterprise',      // keys defined in Agent Settings
    region: 'eu-west'
  }
});

Respondo.track(name, properties?)#

موجودہ وزیٹر کے لیے کلائنٹ سائیڈ ایونٹ ریکارڈ کرتا ہے (مثلاً خریداری، پلان اپ گریڈ)۔ ایونٹس ایونٹ سے چلنے والے Tours شروع کر سکتے ہیں اور ٹور کے اہداف میں شمار ہوتے ہیں۔ ترسیل best-effort ہے اور keepalive استعمال کرتی ہے، اس لیے نیویگیشن سے عین پہلے بھیجے گئے ایونٹس (چیک آؤٹ ری ڈائریکٹ) بھی پہنچ جاتے ہیں۔ init() کے بعد کال کریں۔

ایونٹس اُن پاپ اپ سرویز کو بھی کھولتے ہیں جو ان کا انتظار کرتے ہیں (When and where): مماثل صفحے پر فوراً، یا 30 منٹ کے اندر ایسے صفحے پر پہنچنے پر، مثلاً ری ڈائریکٹ کے بعد۔

Respondo.track('purchase_completed', {
  plan: 'pro',
  amount: 49
});

Respondo.startSurvey(surveyId)#

کسی بھی صفحے پر ایک فعال پاپ اپ سروے ابھی کھولتا ہے، اور Show on، صفحے کے اصول، صفحے پر وقت، ٹرگر ایونٹ اور سامعین کو نظرانداز کرتا ہے۔ آئی ڈی سروے ایڈیٹر سے کاپی کریں (Additional ways to share)۔ جس سروے کا وزیٹر جواب دے چکا ہو وہ دوبارہ نہیں دکھایا جاتا۔ ویجٹ کے لوڈ ہونے سے پہلے بھی کال کیا جا سکتا ہے۔

Respondo.startSurvey('<survey-id>');

Respondo.destroy()#

ویجٹ کو صفحے سے ہٹا دیتا ہے۔ SPA میں کارآمد ہے جب ایسے صفحات پر جانا ہو جہاں ویجٹ نہیں دکھنا چاہیے۔ یہ وزیٹر کی شناخت یا محفوظ گفتگو صاف نہیں کرتا — لاگ آؤٹ کے لیے Respondo.reset() استعمال کریں۔

// Remove widget from the page
Respondo.destroy();

// Reinitialize later if needed (resumes the same conversation)
Respondo.init({ agentId: 'YOUR_AGENT_ID' });

Respondo.reset()#

لاگ آؤٹ / مشترکہ ڈیوائس کی حوالگی۔ براؤزر سے گمنام وزیٹر ID، محفوظ گفتگو اور سیشن ٹوکن صاف کرتا ہے، سیشن ٹوکن کو سرور کی طرف بھی منسوخ کر دیتا ہے تاکہ اس کی نقلیں کام کرنا بند کر دیں، اور ایک تازہ گمنام ویجٹ دوبارہ نصب کر دیتا ہے۔ اسے اپنی ایپ کے لاگ آؤٹ ہُک سے کال کریں۔

// On logout — wipe identity, conversation and session, start fresh
Respondo.reset();