API جاوااسکریپت ویجت

با این API می‌توانید از کد سایت، ویجت را باز/بسته کنید، به رویدادها گوش دهید و اطلاعات کاربر را بدون بارگذاری مجدد صفحه به‌روزرسانی کنید.

📌

پیش‌نیاز: نصب ویجت روی سایت. همهٔ متدها از طریق تابع FlowChat فراخوانی می‌شوند.

روش فراخوانی

index.js


FlowChat("method", parameters);

قبل از فراخوانی مطمئن شوید اسکریپت ویجت بارگذاری شده:


if (window.FlowChat) {
  FlowChat("open");
}

کنترل نمایش

متد	کار
`open`	باز کردن ویجت
`close`	بستن ویجت
`hide`	مخفی کردن (بدون حذف از DOM)
`show`	نمایش مجدد ویجت مخفی‌شده

open.js


FlowChat("open");
FlowChat("close");
FlowChat("hide");
FlowChat("show");

رویدادها

رویداد	زمان اجرا
`onOpen`	ویجت برای کاربر باز شد
`onClose`	ویجت بسته شد
`onHide`	شروع مخفی شدن
`onShow`	شروع نمایش مجدد

events.js


FlowChat("onOpen", () => {
  console.log("چت باز شد");
});
 
FlowChat("onClose", () => {
  console.log("چت بسته شد");
});

به‌روزرسانی تنظیمات (`update`)

بدون رفرش صفحه می‌توانید اطلاعات کاربر و ویژگی‌های سفارشی را تغییر دهید:

update.js


FlowChat("update", {
  chatbot_id: "YOUR_CHATBOT_ID",
  name: "سارا احمدی",
  email: "sara@example.com",
  phone: "09120000000",
  subscription_plan: "طلایی",
  signed_up: true,
});

⚠️

برای ویژگی‌های حساس (مثل وضعیت اشتراک) از JWT امضاشده استفاده کنید؛ جزئیات در امنیت چت‌بات.

مثال کاربردی

دکمهٔ «کمک» در سایت که ویجت را باز می‌کند و سوال از پیش‌انتخاب‌شده می‌فرستد:

help-button.js


FlowChat("onOpen", () => {
  Analytics.track("chat_opened");
});
 
document.querySelector("#help-button").addEventListener("click", () => {
  FlowChat("open");
  FlowChat("update", { preselected_question: "پیگیری سفارش" });
});

عیب‌یابی

مشکل	راه‌حل
`FlowChat is not defined`	اسکریپت ویجت هنوز لود نشده؛ بعد از `onload` یا با `if (window.FlowChat)` صدا بزنید
`update` اثر نمی‌کند	`chatbot_id` را در آبجکت `update` هم بفرستید
رویداد اجرا نمی‌شود	رویداد را قبل از اولین `open` ثبت کنید