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', // اختیاری، برای راستی‌آزمایی هویت
  metadata: { plan: 'pro' },
  properties: {                      // ویژگی‌های سفارشی مخاطب
    account_type: 'enterprise',      // کلیدها در تنظیمات عامل تعریف می‌شوند
    region: 'eu-west'
  }
});

Respondo.track(name, properties?)#

رویدادی سمت کلاینت برای بازدیدکنندهٔ جاری ثبت می‌کند (مثلاً خرید، ارتقای پلن). رویدادها می‌توانند تورهای رویدادمحور را آغاز کنند و در هدف تورها شمرده شوند. تحویل best-effort با keepalive انجام می‌شود، پس رویدادهایی که درست پیش از ناوبری (ریدایرکت پرداخت) شلیک می‌شوند هم می‌رسند. پس از init() فراخوانی کنید.

رویدادها نظرسنجی‌های پاپ‌آپی را که منتظرشان هستند هم باز می‌کنند (When and where): بی‌درنگ در صفحه‌ای منطبق، یا هنگام رسیدن به چنین صفحه‌ای ظرف ۳۰ دقیقه، مثلاً پس از یک ریدایرکت.

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() استفاده کنید.

// ویجت را از صفحه بردار
Respondo.destroy();

// در صورت نیاز، بعداً دوباره مقداردهی کن (همان گفت‌وگو ادامه می‌یابد)
Respondo.init({ agentId: 'YOUR_AGENT_ID' });

Respondo.reset()#

خروج از حساب / تحویل دستگاه مشترک. شناسهٔ ناشناس بازدیدکننده، گفت‌وگوی ذخیره‌شده و توکن نشست را از مرورگر پاک می‌کند، توکن نشست را سمت سرور باطل می‌کند تا نسخه‌های آن از کار بیفتند، و ویجت ناشناس تازه‌ای دوباره سوار می‌کند. این متد را از هوک خروجِ اپ‌تان صدا بزنید.

// هنگام خروج — هویت، گفت‌وگو و نشست را پاک کن و از نو شروع کن
Respondo.reset();