کیت جاوااسکریپت
با window.HiChat ویجت را از داخل سایتتان کنترل کنید و به رویدادهای گفتگو گوش بدهید.
بعد از گذاشتن کد ویجت، تابع HiChat در صفحه در دسترس است. لازم نیست صبر کنید تا ویجت بارگذاری شود؛ دستورها در صف می‌مانند و به ترتیب اجرا می‌شوند.
HiChat('open')
HiChat('on', 'message:received', function (m) {
console.log('پیام تازه از', m.from)
})بعد از بارگذاری، می‌توانید به شکل HiChat.open() هم صدا بزنید.
دستورها
| دستور | کار |
|---|---|
open | باز کردن پنجره گفتگو |
close | بستن پنجره |
toggle | باز یا بسته کردن |
show / hide | نمایش یا پنهان کردن کامل ویجت |
destroy | حذف ویجت از صفحه |
setUser(user) | معرفی کاربر؛ شناسایی کاربر را ببینید |
getUser() | مشخصات فعلی بازدیدکننده |
resetUser() | فراموش کردن بازدیدکننده (مثلا بعد از خروج از حساب) |
setData(data) | ذخیره اطلاعات دلخواه، مثل نوع اشتراک یا تعداد سفارش |
setTags(tags) | برچسب‌های بازدیدکننده |
setDepartment(id) | انتخاب بخش برای گفتگوی بعدی |
sendMessage(text) | باز کردن ویجت و فرستادن پیام از طرف بازدیدکننده |
on(event, fn) / off(event, fn) | گوش دادن به رویدادها |
نمونه setData
HiChat('setData', { plan: 'طلایی', orders: 3, vip: true })حداکثر ۳۰ کلید؛ مقدارها متن (تا ۳۰۰ حرف)، عدد یا true/false هستند. این اطلاعات در نیم‌رخ کاربر در پنل دیده می‌شود.
رویدادها
| رویداد | داده |
|---|---|
ready | ویجت آماده است |
open / close | پنجره باز یا بسته شد |
message:received | { id, text, from } |
message:sent | { id, text } |
conversation:started | { id } |
conversation:closed | { id } |
rating:submitted | { score } |
form:submitted | { kind } |
unread:changed | تعداد پیام‌های خوانده‌نشده |
custom | { name, data } که از REST API فرستاده شده |
رویدادها هیچ‌وقت یادداشت‌های داخلی همکاران را شامل نمی‌شوند.