JavaScript API
מתודות גלובליות הזמינות לאחר טעינת סקריפט הווידג׳ט.
Respondo.init(config)
מאתחל ומעגן את הווידג׳ט. חייב להיקרא פעם אחת. מחזיר את מופע הווידג׳ט.
const widget = Respondo.init({
agentId: 'YOUR_AGENT_ID'
});Respondo.identify(identity)
מצרף זהות משתמש לסשן הנוכחי. קראו לאחר ההתחברות. עם אימייל או userId יוצר את איש הקשר מיד, גם אם המשתמש אף פעם לא פותח את הצ׳אט. signedUpAt (Date, שניות Unix או מחרוזת ISO 8601) הוא מועד ההרשמה של המשתמש למוצר שלכם; בלעדיו תאריך ההרשמה של איש הקשר נשאר ריק.
Respondo.identify({
email: 'user@example.com',
name: 'John Doe',
userId: 'usr_123',
signedUpAt: '2024-05-31T10:00:00Z',
userHash: 'hmac_sha256_signature', // אופציונלי, לאימות זהות
metadata: { plan: 'pro' },
properties: { // מאפייני איש קשר מותאמים
account_type: 'enterprise', // מפתחות מוגדרים ב-Agent Settings
region: 'eu-west'
}
});Respondo.track(name, properties?)
מתעד אירוע צד-לקוח עבור המבקר הנוכחי (למשל רכישה, שדרוג תוכנית). אירועים יכולים להתניע סיורים (Tours) מבוססי-אירוע ולהיספר ליעדי סיור. מסירה במאמץ מיטבי עם 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.open(message?) / Respondo.close()
פותחת או סוגרת את חלון הצ׳אט מכפתורים משלכם. העבירו מחרוזת ל-open כדי לפתוח עם תיבת ההודעה כבר מלאה. קראו לה אחרי Respondo.init(); קריאה שמתבצעת בזמן שהמפעיל עדיין מופיע תוחל ברגע שיופיע.
Respondo.open();
Respondo.open('I have a question about my invoice');
Respondo.close();Respondo.destroy()
מסיר את הווידג׳ט מהעמוד. שימושי ב-SPA בעת ניווט לעמודים שבהם הווידג׳ט לא אמור להופיע. הוא אינו מנקה את זהות המבקר או את השיחה השמורה — להתנתקות, השתמשו ב- Respondo.reset().
// הסרת הווידג׳ט מהעמוד
Respondo.destroy();
// אתחלו מחדש מאוחר יותר במידת הצורך (ממשיך את אותה שיחה)
Respondo.init({ agentId: 'YOUR_AGENT_ID' });Respondo.reset()
התנתקות / החלפת משתמש במכשיר משותף. מנקה מהדפדפן את מזהה המבקר האנונימי, את השיחה השמורה ואת טוקן הסשן, מבטל את טוקן הסשן בצד השרת כך שעותקים שלו מפסיקים לעבוד, ומעגן מחדש וידג׳ט אנונימי טרי. קראו לזה מ-hook ההתנתקות של האפליקציה שלכם.
// בעת התנתקות — מחיקת זהות, שיחה וסשן, התחלה מחדש
Respondo.reset();איסוף נתונים אוטומטי
הווידג׳ט לוכד ושומר אוטומטית את הפרטים הבאים עם כל שיחה:
| נתון | מקור |
|---|---|
| כתובת IP של הלקוח | כותרות HTTP |
| דפדפן / מערכת הפעלה | כותרת User-Agent |
| שפה | כותרת Accept-Language |
| אזור זמן | Intl API (JavaScript) |
| כתובת URL של העמוד | window.location |
| מפנה (Referrer) | כותרת Referer |