נקודת גישה ישירה ל-API לצ'אט

נקודת הגישה הישירה (DAP) ל-API של הצ'אט מאפשרת לכם להפנות באופן אוטומטי סשנים נכנסים של צ'אט לתור על סמך תגובה מנקודת קצה ל-API חיצונית שהגדרתם. כך משתמשי הקצה לא צריכים לבחור מתוך תפריט של תורים. נקודת הקצה יכולה להיות שלכם או של שירות צד שלישי.

כשהיכולת הזו מופעלת, כשמשתמש קצה מתחיל צ'אט, CCAI Platform שולחת בקשה לנקודת קצה ל-API. ה-API מחזיר נתובי ניתוב (צמדי מפתח/ערך), שפלטפורמת CCAI משתמשת בהם כדי להתאים את משתמש הקצה לתור הנכון. אם לא נמצאה התאמה, תפריט התור הרגיל יופיע כברירת מחדל.

ה-API של DAP פועל במקרים הבאים:

  • צ'אטים במחשב ובנייד

  • שיחות חדשות ושיחות שהופעלו מחדש

לפני שמתחילים

היכולת הזו מושבתת כברירת מחדל. כדי להפעיל את התכונה במופע שלכם, צריך לפנות אל Google Cloud התמיכה.

סוגי DAP

יש שני סוגים של DAP: תגובת API ותגובת webhook. לכל סוג של פלטפורמה לניהול נתונים יש תהליך עבודה שונה.

תגובה מה-API

כך נראה תהליך העבודה של תגובת ה-API:

  1. משתמש קצה מתחיל שיחה חדשה או ממשיך שיחה קיימת.

  2. לפני שתפריט התור מופיע, CCAI Platform שולחת בקשה לנקודת קצה ל-API, כולל כל הפרמטרים שהגדרתם, כמו מטא-נתונים של הסשן או נתונים מותאמים אישית.

  3. ה-API מחזיר צמד אחד או יותר של מפתח/ערך.

  4. פלטפורמת CCAI מתאימה את הצמדים האלה לצמדי מפתח/ערך שהוגדרו בתורי הצ'אט. כל הזוגות צריכים להיות זהים כדי שהצ'אט ינותב לתור.

  5. אם נמצאת התאמה, משתמש הקצה מנותב ישירות לתור הזה.

  6. תפריט התור הרגיל מופיע אם מתרחש אחד מהמקרים הבאים:

    • לא נמצאה התאמה.

    • ה-API לא מגיב במסגרת הזמן הקצוב לתפוגה של בקשת ה-API שהוגדר.

תגובה לפעולה מאתר אחר (webhook)

כך נראה תהליך העבודה של תגובת ה-webhook:

  1. משתמש קצה מתחיל שיחה חדשה או ממשיך שיחה קיימת.

  2. לפני שתפריט התור מופיע, CCAI Platform שולחת בקשה לנקודת קצה ל-API, כולל webhook URL.

  3. ה-API מחזיר תגובת אישור (HTTP 200) במסגרת הזמן הקצוב לתפוגה של בקשת ה-API.

  4. המערכת שלכם מעבדת את הבקשה ושולחת נתוני ניתוב (צמדי מפתח-ערך) ל-CCAI Platform באמצעות ה-webhook.

  5. פלטפורמת CCAI מתאימה את הצמדים האלה לצמדי מפתח/ערך שהוגדרו בתורי הצ'אט. כל הזוגות צריכים להיות זהים כדי שהצ'אט ינותב לתור.

  6. אם נמצאת התאמה, משתמש הקצה מנותב ישירות לתור הזה.

  7. תפריט התור הרגיל מופיע אם מתרחש אחד מהמקרים הבאים:

    • לא נמצאה התאמה.

    • האישור לא מתקבל לפני שחלף הזמן הקצוב לתפוגה של בקשת ה-API.

    • התגובה של ה-webhook לא מתקבלת לפני שפג הזמן הקצוב לתפוגה של הקריאה החוזרת של ה-API.

הגדרת DAP API לצ'אט באופן גלובלי

כדי להגדיר DAP של API לצ'אט באופן גלובלי, מבצעים את השלבים הבאים:

  1. בפורטל של CCAI Platform, לוחצים על הגדרות > הגדרות למפתחים. אם תפריט ההגדרות לא מופיע, לוחצים על תפריט.

  2. עוברים לחלונית API Request Direct Access Point (נקודת גישה ישירה לבקשת API) ולוחצים על Manage API Request Direct Access Point (ניהול נקודת גישה ישירה לבקשת API).

  3. לוחצים על הכרטיסייה צ'אט.

  4. לוחצים על המתג API Request Direct Access Point for Chat כדי להעביר אותו למצב מופעל.

  5. בקטע סוג נקודת גישה ישירה, בוחרים באחד מסוגי ה-DAP הבאים:

    • תגובת API: ה-API מחזיר נתוני ניתוב בתגובה שלו.

    • תגובה לפעולה מאתר אחר (webhook): ה-API מאשר את הבקשה, ואז שולח נתוני ניתוב לתגובה לפעולה מאתר אחר (webhook).

  6. כדי לציין אילו סוגי צ'אטים מפעילים את ה-API של DAP, בוחרים באפשרות סוגי צ'אטים אחת או יותר מהאפשרויות הבאות:

    • שיחות חדשות

    • המשך שיחות

  7. בשדה API Request (בקשת API), מזינים את כתובת ה-URL של נקודת קצה ל-API שבה רוצים להשתמש עבור ה-DAP.

  8. כדי להגדיר אימות, מבצעים אחת מהפעולות הבאות:

    • כדי להגדיר אימות בסיסי:

      1. בקטע שיטת אימות, בוחרים באפשרות אימות בסיסי.

      2. בקטע פרטי כניסה לאימות, מזינים את שם המשתמש והסיסמה.

    • כדי להגדיר כותרת בהתאמה אישית:

      1. בקטע שיטת אימות, בוחרים באפשרות כותרת בהתאמה אישית.

      2. לוחצים על הוספת שדה. מופיעה תיבת הדו-שיח הוספת שדה.

      3. מזינים מפתח שדה וערך שדה ולוחצים על שמירה.

  9. כדי להגדיר את פרק הזמן הקצוב לתפוגה של בקשת ה-API:

    1. בקטע API Request Timeout (פסק זמן של בקשת API), מגדירים את מספר השניות שמערכת CCAI Platform תמתין לתגובה מה-API לפני שיחול פסק זמן.

    2. אופציונלי (מופיע רק אם בחרתם בסוג DAP‏ Webhook Response): בשדה API Callback Timeout (זמן קצוב לתגובה של API), מגדירים את מספר השניות שמערכת CCAI Platform מחכה לנתוני ניתוב מה-webhook (אחרי האישור הראשוני) לפני שהיא מפסיקה לחכות.

  10. כדי להגדיר את שיטת הבקשה, בוחרים באפשרות POST או GET בשיטת בקשת API.

  11. כדי להגדיר פרמטר נתונים:

    1. מעבירים את המתג העברת פרמטרים של נתונים למצב פעיל.

    2. לוחצים על הוספת פרמטר. מופיעה תיבת הדו-שיח Add Parameter (הוספת פרמטר).

    3. מבצעים אחת מהפעולות הבאות:

      • כדי להגדיר פרמטר נתונים קבוע:

        1. ברשימה סוג, לוחצים על קבוע.

        2. בשדה Destination Field (שדה יעד), מזינים את מפתח היעד.

        3. בשדה ערך יעד, מזינים את ערך היעד. תצוגה מקדימה של פרמטר הנתונים מופיעה בשדה תצוגה מקדימה.

      • כדי להגדיר פרמטר של נתונים דינמיים:

        1. ברשימה סוג, לוחצים על דינמי.

        2. מבצעים אחת מהפעולות הבאות:

          • כדי להגדיר את המטא-נתונים של הסשן:

            1. ברשימה Source, בוחרים באפשרות Session Metadata.

            2. ברשימה Incoming Field, בוחרים סוג מטא-נתונים.

          • כדי להגדיר נתונים מותאמים אישית חתומים:

            1. ברשימה מקור, בוחרים באפשרות נתונים מותאמים אישית חתומים.

            2. ברשימה Incoming Field (שדה נכנס), מזינים את השדה הנכנס.

          • כדי להגדיר נתונים מותאמים אישית לא חתומים:

            1. ברשימה מקור, בוחרים באפשרות נתונים מותאמים אישית לא חתומים.

            2. ברשימה Incoming Field (שדה נכנס), מזינים את השדה הנכנס.

        3. בשדה Destination Field (שדה יעד), מזינים את שדה היעד. תצוגה מקדימה של פרמטר הנתונים מופיעה בשדה תצוגה מקדימה.

    4. לוחצים על הוספת פרמטר. פרמטר הנתונים מופיע ברשימה Data Parameters.

  12. אופציונלי: כדי לבדוק את ההגדרה:

    1. עוברים לקטע בדיקת החיבור. פרמטרי הנתונים יופיעו ברשימה.

    2. אופציונלי: כדי לנסות ערכים שונים של פרמטרים, עורכים את הערכים של הפרמטרים ברשימה.

    3. לוחצים על בדיקת החיבור.

  13. לוחצים על שמירת Chat API.

שינוי הלוגיקה של הניתוב

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

אלה שלושת סוגי ההתאמה:

  • תגובת API: התאמות שמבוססות על זוגות של מפתח וערך בתגובת ה-API.

  • תווית כללית של נקודת גישה: התאמה על סמך התווית הכללית של נקודת הגישה בתור.

  • פילוח משתמשים: התאמות שמבוססות על נתונים של פלחי משתמשים.

כדי לשנות את לוגיקת הניתוב:

  1. בפורטל של CCAI Platform, לוחצים על הגדרות > הגדרות למפתחים. אם תפריט ההגדרות לא מופיע, לוחצים על תפריט.

  2. עוברים לחלונית API Request Direct Access Point (נקודת גישה ישירה לבקשת API) ולוחצים על Manage API Request Direct Access Point (ניהול נקודת גישה ישירה לבקשת API).

  3. לוחצים על הכרטיסייה צ'אט.

  4. בקטע לוגיקת ניתוב, מעבירים את מצביע העכבר מעל סוג התאמה וגוררים אותו למיקום חדש.

  5. חוזרים על השלב הזה לפי הצורך.

  6. לוחצים על שמירת Chat API.

הגדרת DAP לצ'אט ברמת התור

כדי להגדיר DAP לצ'אט ברמת התור, פועלים לפי השלבים הבאים:

  1. בפורטל של CCAI Platform, לוחצים על הגדרות > תור. אם לא רואים את תפריט ההגדרות, לוחצים על תפריט. מופיע הדף הגדרות תפריט התור.

  2. בהתאם לערוץ הרצוי, מבצעים אחת מהפעולות הבאות:

    • בחלונית נייד, לוחצים על עריכה / הצגה.

    • בחלונית אינטרנט, לוחצים על עריכה / הצגה.

  3. לוחצים על התור שרוצים לערוך.

  4. בחלונית הגדרות, עוברים לקטע נקודת גישה.

  5. לוחצים על יצירת נקודת גישה ישירה. מופיעה תיבת הדו-שיח Create Direct Access Point (יצירת נקודת גישה ישירה).

  6. ברשימה Access Point Type (סוג נקודת הגישה), לוחצים על API Response (תגובת API).

  7. בשדה Access Point Name (שם נקודת הגישה), מזינים שם של נקודת גישה.

  8. לוחצים על הוספת מפתח וערך. מזינים צמד מפתח/ערך שרוצים להתאים לצמד מפתח/ערך שמוחזר בתגובת ה-API.

  9. חוזרים על השלב הקודם כדי להוסיף עוד צמדי מפתח/ערך.

  10. אופציונלי: בשדה הודעת פתיחה, מזינים את הודעת הפתיחה שרוצים להשתמש בה כשמשתמש קצה מועבר לאפשרות הזו בתפריט.

  11. לוחצים על יצירה. ה-DAP יופיע ברשימה Access Point.