שדרוג מגרסה 2 של Web SDK לגרסה 3 של Web SDK

בדף הזה מוסבר איך לשדרג מגרסה 2 של web SDK לגרסה 3 של web SDK. אם אתם מתקינים את ה-SDK לאתרים בפעם הראשונה, כדאי לעיין במדריך ל-Web SDK v3.

יכולות של Web SDK v3

אלה כמה יכולות של web SDK v3 שלא קיימות ב-web SDK v2:

  • טפסים בהתאמה אישית: נציגים יכולים לשלוח טפסים מותאמים לאיסוף נתונים ישירות בממשק הצ'אט באינטרנט. מידע נוסף זמין במאמר בנושא טפסים לאיסוף נתונים.

  • תמלילים להורדה: מאפשרים למשתמשי הקצה להוריד את תמלילי הצ'אט שלהם ישירות מהווידג'ט. מידע נוסף זמין במאמר בנושא הורדת תמלילי צ'אטים באמצעות web SDK ו-SDK לנייד.

  • טריגרים מתקדמים לשיחות יזומות: שימוש בטריגרים מתקדמים לשיחות יזומות – למשל, ציון השפה של התור או שימוש בלוגיקה מורכבת של AND-OR למילות מפתח של כתובות URL. מידע נוסף זמין במאמר בנושא טריגרים של Proactive Web SDK.

שדרוג לגרסה 3 של Web SDK

קודם, מאתרים את הסקריפט הזה בקוד המקור:

<script type="module" src="https://websdk.ujet.co/v2/loader.js"></script>

לאחר מכן, מחליפים אותה בשורה הבאה:

<script type="module" src="https://{your_ccaas_host}/web-sdk/v3/widget.js"></script>

הבדלים משמעותיים

‫SDK v3 לאינטרנט מבוסס ישירות על לקוח UJET headless. ממשק המשתמש של הווידג'ט משתמש במבנה הזה ללא ראש, ולכן אפשר לגשת לכל השיטות הבסיסיות ולבצע קריאות לשיטות האלה, וגם להאזין לאירועים שה-SDK ללא ראש תומך בהם, על ידי טירגוט של ccaas.client.

בקטע הזה מפורטים ההבדלים העיקריים בין גרסה 2 לגרסה 3 של ה-SDK לאינטרנט.

התחלה

v2

const ccas = new UJET({
  "companyId": "{companyId}",
  "host": "https://{your_ccaas_host}",
  "authenticate": getAuthToken
})

v3

var ccas = new UJET({
  "companyId": "{companyId}",
  "host": "https://{your_ccaas_host}",
  "authenticate": getAuthToken
})

// v3 has a mount point
// ccaas.mount(HTMLElement | string)
ccaas.mount('#ccaas-widget')

אפשרויות

כשמפעילים את ה-SDK לאתרים, מציינים אפשרויות. בקטע הזה מוסברים ההבדלים בין גרסה 2 לגרסה 3 של ה-SDK לאתרים.

v2

לא רלוונטי לגרסה 2.

v3

בגרסה 3, אפשרויות האתחול זהות לאלה של Headless SDK.

interface ClientOption {
  companyId: string;
  authenticate: () => Promise<TokenResponse>;
  tenant?: string;
  host?: string;
  lang?: string;
  bridge?: string;
  cobrowse?: {
    enabled: boolean;
    template?: string;
    messages?: CobrowseMessages;
    api?: string;
    license?: string;
    trustedOrigins?: string[];
    capabilities?: string[];
    registration?: boolean;
    redactedViews?: string[];
    unredactedViews?: string[];
  };
}

אפשר להגדיר אפשרויות נוספות באמצעות ה-method‏ ccaas.config():

ccaas.config({
  disableAttachment: true
})

אפשרויות ההגדרה הזמינות:

interface ConfigOptions {
  accent?: AccentColor;
  logo?: string;
  menuKey?: string;
  ticketId?: string;
  preferredChannel?: string;
  disableAttachment?: boolean;
  customData?: string | Record<string, any>;
  messages?: Record<string, unknown>;
  reCaptchaSiteKey?: string;
}

Methods

בגרסה 2, יש כמה שיטות נוספות בטוען, כמו:

ccaas.createCobrowseCode()
ccaas.fetchWaitTimes({id: 123})

בגרסה 3, ממשק המשתמש של הווידג'ט משתמש בלקוח ללא GUI, ואפשר להפעיל את כל השיטות שנתמכות על ידי ה-SDK ללא GUI.

const client = ccaas.client
client.getCompany()
client.loadOngoingChat()

מידע נוסף זמין במדריך ל-SDK לאינטרנט ללא ממשק משתמש.

אירועים

בגרסה 2, אפשר להאזין לאירועים באמצעות:

ccaas.on('chat:update', (chat) => {
  console.log(chat)
})

בגרסה 3, אפשר להאזין לאירועים באמצעות לקוח headless:

const client = ccaas.client

client.on('chat.updated', (chat) => {
  console.log(chat)
})

מידע נוסף על אירועים זמין במדריך בנושא Headless web SDK.

התאמה אישית של העיצוב

בגרסה 3 של Web SDK יש גישה מעודכנת להתאמה אישית של עיצובים. מידע נוסף זמין במאמר בנושא התאמה אישית של ערכות נושא.