פתרון ה-CRM המותאם אישית מאפשר לחברות להשתמש בפורטל של פלטפורמת ה-AI למוקדי שירות לקוחות (CCAI Platform) אם הן משתמשות במערכת CRM שלא משולבת כרגע עם CCAI Platform. הגדרה של מערכת CRM בהתאמה אישית פועלת כשמשתמשים במערכת CRM שפותחה בתוך הארגון או בכל מערכת CRM לא סטנדרטית.
נציגים מטפלים בשיחות ובצ'אטים, ומנהלים יכולים לעקוב אחרי השיחות והצ'אטים ולהפיק דוחות באמצעות הפורטל של פלטפורמת CCAI. כל הפרטים על השיחה או על סשן הצ'אט מאוחסנים בקובץ מטא-נתונים של הסשן. הקובץ הזה יכול להכיל יותר מ-20 נקודות נתונים, כולל פרטי סשן, העברות, משך הטיפול, משתתפים, מידע אבחוני ועוד. אפשר לנתח את קובץ המטא-נתונים של הסשן ולהשתמש בו לניתוח ולמעקב אחרי הסשן.
המטא-נתונים של הסשן וקבצי המדיה שהצרכנים העלו מועברים לשירות אחסון חיצוני, והסוכנים יכולים לראות את קובצי המדיה שהצרכנים העלו ישירות במתאם הסוכן במהלך הסשן.
פתרון CRM בהתאמה אישית מיושם באמצעות שילוב של הרכיבים הבאים. יכול להיות שחלק מהרכיבים רלוונטיים להגדרה שלכם ויכול להיות שלא:
יצירת קובץ מטא-נתונים של הסשן לכל שיחה וסשן צ'אט
שליחת מטא-נתונים וקבצי מדיה לשירות אחסון חיצוני
שילוב API כללי
כתובת URL של חיפוש בהתאמה אישית
עדכון רשומה ב-CRM באמצעות אימייל
חיפוש חשבון או פנייה דרך המתאם של הסוכן
דרישות מוקדמות
כדי להשתמש בתכונה 'מערכת CRM בהתאמה אישית', קודם צריך להגדיר אחסון חיצוני. מידע נוסף מופיע במאמר בנושא אחסון חיצוני לפתרונות CRM בהתאמה אישית.
מטא-נתונים של סשן
קובץ המטא-נתונים של הסשן מכיל מידע מפורט על הסשן. האימייל הזה נשלח 15 דקות אחרי שהסשן מסתיים. מידע נוסף זמין במאמר בנושא קובץ מטא-נתונים של סשן.
שיטות מותאמות אישית לשילוב עם מערכות CRM
| Generic API | כתובת URL מותאמת אישית | |
|---|---|---|
| חיפוש חשבון | כן | כן |
| חיפוש פנייה | כן | |
| עדכון לגבי בקשת תמיכה | כן | לא |
Generic API
שיטת השילוב של Generic API מאפשרת להשתמש ב-API של מערכת ה-CRM המותאמת אישית כדי ליצור חיבור דו-כיווני עם CCAI Platform. השיטה החלקה הזו דומה לחוויית השילוב של מערכת CRM מוכנה לשימוש. הסוכן לא צריך לבצע פעולה כדי ליצור רשומה ב-CRM עבור שיחות או צ'אטים, בהתאם להגדרת ה-API הייחודית. הוא יכול לאפשר חיפוש חלק של רשומות ועדכון רשומות.
כתובת URL מותאמת אישית
האפשרות 'קישור בהתאמה אישית' מאפשרת לנציגים שלכם ליצור אינטראקציה עם מערכת ה-CRM באמצעות קישור בהתאמה אישית שנוצר לכל סשן. בניגוד לשילוב CRM רגיל ולחוויית השימוש ב-API כללי, הסוכן צריך לבצע פעולה כדי ליצור רשומה ב-CRM. במקרים מסוימים, יכול להיות שהנציג יצטרך רק לפתוח כרטיסייה עם הקישור המותאם אישית מהשיחה, ובמקרים אחרים הוא יצטרך ליצור את הרשומה באופן ידני.
פרטים והגדרות של כתובות URL מותאמות אישית של חיפוש
הפונקציונליות הבסיסית של כתובת ה-URL היא לבצע חיפוש במערכת CRM, אבל בהתאם למערכת ה-CRM, אפשר להפעיל תהליכים מורכבים יותר על סמך התוכן של כתובת ה-URL המותאמת אישית. אפשר להגדיר את כתובת ה-URL של ה-CRM המותאם אישית עם משתנים שמכילים מידע על הסשן, והיא נגישה במתאם של הנציג במהלך הסשן. אחרי שתיגשו לכתובת ה-URL, היא תפעיל את מערכת ה-CRM המותאמת אישית כדי לבצע חיפוש. חיפוש במערכת לניהול קשרי לקוחות (CRM) מאפשר לסוכנים להשתמש ב'חלון קופץ של כרטיס' עבור שיחה או סשן צ'אט פעילים. תהליך הקישור המותאם אישית מסתמך אך ורק על היכולת של מערכת ה-CRM המותאמת אישית לעבד את הקישור הזה ולשנות או לכתוב אותו מחדש אם צריך.
המטא-נתונים של הסשן, הקלטות השיחות וקבצים אחרים שמאוחסנים חיצונית לא יקושרו לרשומה במערכת ה-CRM, אלא אם נעשה שימוש גם בשיטת העדכון באימייל שמופיעה ברשימה.
בהגדרה הזו, הסוכן יתחבר לפורטל של פלטפורמת CCAI ויתחבר למערכת ה-CRM שלו בכרטיסיות נפרדות. השיחות והצ'אטים יתנהלו בכרטיסייה CCAI Platform, ופרטי הכרטיס יופיעו בכרטיסייה של מערכת ה-CRM.
כדי שההגדרה הזו תפעל:
ה-Agent צריך להיות מחובר ל-CRM בדפדפן
ה-Agent צריך להיות מחובר לפורטל של פלטפורמת CCAI בדפדפן שלו
צריך להגדיר מראש את כתובת ה-URL המותאמת אישית של החיפוש
מערכת ה-CRM צריכה לטפל בכתובת ה-URL המותאמת אישית כדי להציג רשומה רלוונטית של CRM
התנהגות של כתובת URL מותאמת אישית לחיפוש
פלטפורמת CCAI תכלול בכתובת ה-URL רק פרמטרים שלא ריקים.
פלטפורמת CCAI לא שומרת את כתובת ה-URL שנוצרה ומכילה את ה-ANI/UID/Email במסד הנתונים של פלטפורמת CCAI אחרי שהסשן מסתיים.
הגדרת כתובת URL מותאמת אישית לחיפוש
בגלל ההבדלים במזהים הייחודיים, ביכולות ובאופן הפעולה של מערכות CRM שונות, תצטרכו ליצור 2 כתובות URL שונות – אחת לסשנים של IVR/PSTN/SMS ואחת לסשנים של SDKs לאינטרנט ולנייד. בסשנים של IVR/PSTN/SMS, מספר הטלפון של המתקשר (ANI) ישמש כמזהה הייחודי, ואילו ב-SDK לנייד ולאינטרנט, סביר להניח שמזהה הלקוח (CUID) וכתובת האימייל ישמשו כמזהים.
אפשר להשתמש במשתנים הבאים כדי להגדיר כתובת URL של בדיקת מידע:
| משתנה | ערכים |
|---|---|
{CUSTOMER_PHONE_NUMBER} |
מספר הטלפון של משתמש הקצה |
{ANI} |
מספר הטלפון של משתמש הקצה. נשמרת לצורך תאימות לאחור. |
{CUID} |
מזהה משתמש מותאם אישית |
{EMAIL} |
כתובת האימייל של משתמש הקצה |
{MENU_PATH} |
נתיב התפריט המלא של התור. לדוגמה, Orders/Order confirmation/Order info. |
{MENU_ID} |
מזהה התפריט |
{CHANNEL} |
הערוץ של הביקור. ערכים אפשריים:
|
{TYPE} |
סוג הסשן. ערכים אפשריים של שיחות:
ערכים אפשריים לצ'אטים:
|
{SUPPORT_PHONE_NUMBER} |
מספר הטלפון של מרכז התמיכה שאליו מתקשר משתמש הקצה. |
{OUTBOUND_NUMBER} |
מספר הטלפון שבו הסוכן משתמש לשיחה יוצאת. |
{SESSION_ID} |
מזהה הסשן. ערכים אפשריים:
|
{CUSTOM_AGENT_ID} |
שדה אופציונלי של מזהה הנציג באובייקט user. אי אפשר לקבל את מזהה הסוכן עד שהסשן נוצר ומוקצה סוכן. לכן, צריך להגדיר את המופע כך שייווצר עיכוב ביצירת רשומות של שיחות או צ'אטים, כדי לאפשר הגדרה של המשתנה הזה. אפשר להגדיר השהיה ביצירת רשומות של שיחות או צ'אטים בהגדרות > ניהול פעולות > פרטים על יצירת רשומות ב-CRM. מידע נוסף זמין במאמר פרטים על יצירת רשומות ב-CRM. |
הגדרת פורטל CCAI Platform
נכנסים לפורטל של פלטפורמת CCAI באמצעות חשבון שהוקצה לו תפקיד אדמין.
עוברים אל הגדרות > הגדרות למפתחים.
בקטע CRM, בוחרים באפשרות CRM בהתאמה אישית.
בקטע חיפוש במערכת CRM, מזינים את כתובות ה-URL המותאמות אישית.
בוחרים את פורמט מספר הטלפון שבו רוצים להשתמש בבקשות ל-CRM.
לוחצים על שמירת השינויים.
אם עדיין לא עשיתם את זה, אתם צריכים להגדיר את שירות האחסון החיצוני. מידע נוסף זמין במאמר בנושא אחסון חיצוני.
עדכון רשומה ב-CRM באמצעות אימייל
בהגדרות כמו כתובת ה-URL של החיפוש המותאם אישית, אחרי שסשן מסתיים, צריך לעדכן את המטא-נתונים של הסשן במערכת ה-CRM. התכונה הזו מאפשרת לפלטפורמת CCAI לשלוח באופן אוטומטי נתוני סשן באמצעות אימייל. כ-15 דקות אחרי סיום הסשן, נשלח אימייל למיקום שהוגדר, ותוכן האימייל משמש לעדכון רשומה במערכת ה-CRM. אפשר להגדיר את התכונה הזו באופן גלובלי או לכל תור בנפרד. אחרי קבלת האימייל, יכול להיות שמערכת ה-CRM מוגדרת לעדכן או ליצור רשומה חדשה ב-CRM עבור הסשן.
פרטי אימייל
נשלחה מהכתובת no-reply@ccaiplatform.com
התכונות הנכללות:
שורת הנושא
גוף הבקשה עם מטא-נתוני הסשן בתחביר JSON
קובץ מצורף בפורמט TXT עם תמליל הצ'אט, אם רלוונטי
פלטפורמת CCAI תמתין 15 דקות אחרי סיום הסשן ואז תשלח את האימייל.
האימיילים נשלחים רק לסשנים שהסתיימו בהצלחה. הוא לא נשלח לסשנים שנכשלו או לסשנים שהמשתמשים הפסיקו באמצע.
הגדרות כלליות
נכנסים לפורטל של פלטפורמת CCAI באמצעות חשבון שהוקצה לו תפקיד אדמין.
עוברים אל הגדרות > הגדרות למפתחים.
בקטע CRM, מוודאים שהאפשרות Custom CRM (מערכת CRM בהתאמה אישית) מסומנת.
מפעילים את האפשרות שליחת תוצאות הסשן באימייל.
מזינים את כתובת האימייל שאליה רוצים לשלוח את האימייל.
לוחצים על שמירת השינויים.
הגדרות לכל תור
נכנסים לפורטל של פלטפורמת CCAI באמצעות חשבון שהוקצה לו תפקיד אדמין.
עוברים אל הגדרות > תור ובוחרים תור משנה כלשהו.
מפעילים את האפשרות שליחת תוצאות הסשן באימייל.
מזינים את כתובת האימייל שאליה רוצים לשלוח את האימייל.

לוחצים על שמירת הגדרות CRM מותאמות אישית.
העברת הגדרות בירושה ושינוי שלהן
| הגדרות | התנהגות |
|---|---|
| Global = NOT enabled Queue = NOT enabled |
לא לשלוח לכל התורים. |
| Global = NOT enabled Queue = Enabled |
ההגדרה של התור (כלומר, מצב ההפעלה או ההשבתה) מבטלת את ההגדרה הגלובלית. אימייל נשלח מתור מסוים לכתובת אימייל שמוגדרת בהגדרה של התור. |
| כללי = מופעל תור = לא מופעל |
הגדרת התור (כתובת אימייל, מצב הפעלה/השבתה) מועברת בירושה מההגדרה הגלובלית. אימייל נשלח מתור מסוים לכתובת אימייל שמוגדרת בהגדרה הגלובלית. |
| גלובלי = מופעל תור = מופעל |
ההגדרה של התור (כתובת אימייל) מבטלת את ההגדרה הגלובלית. האימייל נשלח מתור נתון לכתובת אימייל שמוגדרת בהגדרות התור. אם כתובת האימייל ריקה, האימייל לא נשלח. |
חוויית ההתקשרות עם הנציג
חיפוש רשומות ב-CRM
נכנסים לפורטל של פלטפורמת CCAI באמצעות חשבון שהוקצתה לו הרשאה של סוכן.
פותחים את המתאם של השיחה או הצ'אט.
כדי להפעיל את החיפוש, לוחצים על הלחצן פתיחה בחלון דפדפן חדש.
משתמשים בלחצן העתקת הקישור כדי להעתיק את כתובת ה-URL של החיפוש ללוח.

אחסון חיצוני לפתרונות CRM בהתאמה אישית
אחסון חיצוני לפתרונות בהתאמה אישית מאפשר להשתמש בשירות אחסון חיצוני כדי לאחסן ולאחזר מטא-נתונים של סשנים בפלטפורמת CCAI, הקלטות של שיחות, תמלילי צ'אטים וקבצים של מדיה שהועלו על ידי הלקוחות. הקבצים מאוחסנים מחוץ למערכת CRM.
כדי להגדיר אחסון חיצוני, חובה שיהיו לכם:
חשבון תקף ב-CCAI Platform עם תפקידים של אדמין וסוכן שהוקצו לצורך הגדרה ובדיקה
שירות אחסון חיצוני
מבנה התיקיות
מבנה התיקיות הבא יאורגן באחסון החיצוני בנתיב התיקייה:
ujet-chat-transcripts
ujet-media
ujet-metadata
ujet-voice-recordings
ujet-voicemails
פורמטים של קבצים ומוסכמות למתן שמות
אפשר להעלות את סוגי הקבצים הבאים לשירות האחסון החיצוני. הקבצים מוצפנים במהלך ההעברה באמצעות HTTPS:
| קובץ | שם |
|---|---|
| הקלטות של שיחות | - call-{id}.mp3 - call-{id}.wav |
| קובצי מדיה | - call-{id}-photo-{photo-id}.jpg - call-{id}-video-{video-id}.mp4 - chat-{id}-photo-{photo-id}.jpg - chat-{id}-video-{video-id}.mp4 |
| תמלילי צ'אט | - chat-{id}.txt |
| מטא-נתונים של סשן | - call-{id}.json - chat-{id}.json |
חוויית ההתקשרות עם הנציג והמפקח
במהלך השיחה או הצ'אט, תמונות וסרטונים שהלקוח העלה באמצעות פעולות חכמות מוצגים במתאם הסוכן.
אם אתם משתמשים באינטראקציה עם מערכת CRM באמצעות כתובת URL מותאמת אישית בשילוב עם שיטת העדכון של קובץ המטא-נתונים של הסשן באימייל, סוכנים ומפקחים יכולים לגשת לפרטי הסשן באמצעות השרת החיצוני שלכם.
הגדרת שירות האחסון החיצוני
כדי להגדיר את האחסון החיצוני, פועלים לפי השלבים הבאים:
נכנסים לפורטל של פלטפורמת CCAI באמצעות חשבון שהוקצתה לו הרשאת אדמין.
עוברים אל הגדרות > הגדרות למפתחים.
בדף 'הגדרות המפתח', עוברים לקטע אחסון חיצוני.
כדי להפעיל את האפשרות לאחסון מידע מחוץ לשרתי ה-CRM, מעבירים את המתג למצב מופעל, ואז בוחרים את סוגי הקבצים שרוצים לאחסן.
בקטע Server Setup (הגדרת השרת), בוחרים את סוג האחסון ומשלימים את שלבי ההגדרה: שרת SFTP, Google Cloud מאגר.
שרת SFTP
מזינים את המארח של SFTP (כתובת URL או כתובת IP).
מזינים את מספר היציאה.
מזינים את מזהה המשתמש להתחברות ל-SFTP.
אם שרת ה-SFTP דורש סיסמה לאימות, מזינים אותה בשדה סיסמה.
אם שרת ה-SFTP דורש מפתח פרטי לאימות, מסמנים את התיבה מפתח פרטי של SSH.
מזינים (מעתיקים ומדביקים) את המפתח הפרטי של SSH.
מזינים את ביטוי הסיסמה של המפתח הפרטי. אם רוצים לשמור את פרטי הסשן בתיקייה ספציפית בשרת ה-SFTP, מסמנים את התיבה נתיב התיקייה ומזינים את נתיב התיקייה ב-SFTP.
לוחצים על שמירת השינויים.
Cloud Storage
מזינים את היעד Google Cloud שם קטגוריית היעד.
מזינים את Google Cloud מזהה הלקוח.
מזינים את Google Cloud סוד הלקוח.
אם רוצים לאחסן את פרטי הסשן בתיקייה ספציפית ב Google Cloud קטגוריה, מסמנים את תיבת הסימון Folder Path (נתיב התיקייה) ומזינים את Google Cloud נתיב התיקייה.
לוחצים על קישור ושמירה.
בדיקת ההגדרה של התקן האחסון החיצוני
למערכות CRM עם שילוב סטנדרטי קיים:
נכנסים למערכת ה-CRM.
נכנסים ל-CCAI Platform בתוך ה-CRM באמצעות פרטי הכניסה ל-CCAI Platform עם תפקיד סוכן שהוקצה.
מתקשרים או מתחילים צ'אט. מוצגת רשומת ה-CRM שמשויכת לסשן.
בסיום הסשן, קובץ התמליל אמור להיות מועלה תוך שניות.
עוברים ישירות לתיקיית האחסון בשרת החיצוני ומוודאים שהקובץ זמין.
שליחת קבצים של סשנים למערכת ה-CRM
כשהאחסון החיצוני מופעל, הגדרות הפיתוח של כתובות ה-URL של האחסון ב-CRM והאחסון החיצוני מאפשרות לשלוח קבצים של סשנים ולקבוע באיזה מקור להשתמש כדי להציג קבצים במתאם של הסוכן.
כדי לראות את ההגדרות האלה, צריך להפעיל את האפשרות 'אחסון חיצוני' בהגדרות > הגדרות למפתחים > אחסון חיצוני. מעבירים את המתג Enable information storage outside CRM servers (הפעלת אחסון מידע מחוץ לשרתי CRM) למצב On (מופעל).
אחסון ב-CRM
עוברים אל הגדרות > הגדרות למפתחים > אחסון חיצוני > אחסון CRM.
מסמנים את התיבה לצד Also send session files to the CRM (שליחת קבצים של סשנים גם ל-CRM) כדי לשלוח קבצים של סשנים, כמו הקלטות של שיחות או תמלילים של צ'אטים, ל-CRM ולאחסון החיצוני שהגדרתם.
לוחצים על שמירת השינויים.
אם תיבת הסימון מסומנת, ההקלטות יישמרו גם במערכת לניהול קשרי לקוחות וגם באחסון החיצוני.
כתובות URL של אחסון חיצוני
כתובת ה-URL של האחסון החיצוני משמשת בשני מקומות:
מתאם הסוכן.
דיווח: כתובת ה-URL של המדיה מוצגת בדוח וגם בתפריטים כמו הגדרות, שיחות, הושלמו.
עוברים אל הגדרות > הגדרות למפתחים > אחסון חיצוני > כתובות URL של אחסון חיצוני
בוחרים את המקור כתובות URL של מערכת CRM או כתובות URL של אחסון חיצוני כדי להציג קבצים במתאם של הנציג.
לוחצים על שמירת השינויים.
אחסון ב-CRM
אם תיבת הסימון של אחסון במערכת CRM לא מסומנת, ההקלטות יישמרו רק באחסון החיצוני, והמערכת תשתמש בקישור למערכת ה-CRM.
אם תיבת הסימון מסומנת, ההקלטות יאוחסנו גם במערכת לניהול קשרי לקוחות (CRM) וגם באחסון החיצוני.
כתובות URL של אחסון חיצוני
כתובת ה-URL משמשת בשני מקומות:
באחד מהם מוצג המדיה במתאם של פלטפורמת CCAI. אחסון חיצוני או מערכת לניהול קשרי לקוחות (CRM).
השני מופיע בדוח. אנחנו חושפים את כתובת ה-URL של המדיה בדוחות וגם בתפריטים כמו 'הגדרות', 'שיחות' ו'הושלמו'.
הצגת CRM מותאם אישית בפורטל של פלטפורמת CCAI
כשמשתמשים בשילוב CRM מותאם אישית עם מערכת CRM מותאמת אישית משלכם, אפשר לטעון את ה-CRM בדף ייעודי בפורטל של פלטפורמת CCAI. אחרי ההפעלה, הכרטיסייה CRM בפורטל של פלטפורמת CCAI נטענת ומוצג בה דף ה-CRM שנוצר בהתאמה אישית. אפשר להגדיר את זה בהגדרות למפתחים > CRM.
היכולת הזו מאפשרת לנציגים לטפל בסשנים של תמיכה בזמן אמת באמצעות מתאמי השיחות והצ'אט של פלטפורמת CCAI, וגם לעבוד במערכת ה-CRM המותאמת אישית שלכם. זה כולל בדיקה של פרטי חשבון ורשומות שנפתחים אוטומטית, ושל קבצים ונתונים ספציפיים לסשן שמועברים מהאפליקציה לנייד או מהלקוחות, והכול באמצעות הפורטל של CCAI Platform.
הגדרת דף CRM מותאם אישית
כדי להגדיר דף CRM בהתאמה אישית, מבצעים את השלבים הבאים:
בפורטל של CCAI Platform, לוחצים על הגדרות > הגדרות למפתחים. אם תפריט ההגדרות לא מופיע, לוחצים על תפריט.
בחלונית CRM, לוחצים על Custom CRM (מערכת CRM בהתאמה אישית).
לוחצים על המתג הצגת ה-CRM בפורטל של פלטפורמת CCAI כדי להעביר אותו למצב פעיל.
בקטע כתובת URL לתצוגה, מזינים את כתובת ה-URL של דף ה-CRM המותאם אישית ולוחצים על שמירה.
פתיחת חלון קופץ של כתובת URL מותאמת אישית
משתמשים באפשרות Open Custom URL (פתיחת כתובת URL מותאמת אישית) כדי להציג חלון קופץ עם כתובת URL מותאמת אישית כשלא נמצא איש קשר במערכת. יוצרים רשומה במערכת לניהול קשרי לקוחות עם מזהה חשבון זמני, ומפעילים קישור מותאם אישית עם פרמטרים שמבוססים על ההגדרה ברמת התור.
הפעלת חלון קופץ במסך לכל תור בנפרד
עוברים אל הגדרות > תור > תגובה קולית אינטראקטיבית (IVR) ולוחצים על תור כדי לערוך אותו.
עוברים אל Open Custom URL (פתיחת כתובת URL מותאמת אישית) בחלונית.
מזינים כתובת URL כדי להציג חלון קופץ.
כוללים את הפרמטרים של המשתנים {ACCOUNT_ID} ו-{PHONE_NUMBER} בכתובת ה-URL.
מצורפת דוגמה.
- לוחצים על שמירה.
שילוב API כללי מותאם אישית של מערכת CRM
שיטת השילוב הגנרית של API מאפשרת להשתמש ב-API של מערכת ה-CRM כדי ליצור חיבור דו-כיווני עם CCAI Platform. השיטה החלקה הזו דומה לחוויית השילוב של מערכת CRM שמוכנה לשימוש.
הסוכן לא צריך לבצע שום פעולה כדי ליצור רשומה במערכת CRM עבור שיחות או סשנים בצ'אט. בהתאם להגדרה הייחודית של ה-API, הוא יכול לאפשר חיפוש חלק של רשומות ועדכון רשומות.
הסברים על המונחים
תקופה |
תיאור |
חשבון |
הוא משמש להתייחסות לישות Account/Contact/Customer/Lead במערכת ה-CRM. יכול להיות שישות כזו מופיעה במערכת ה-CRM שלכם בשם אחר. החשבונות מכילים רשומות. |
רשומה |
הוא משמש להפניה לישות Case/Ticket/Conversation/Incident במערכת ה-CRM. יכול להיות שישות כזו מופיעה במערכת ה-CRM שלכם בשם אחר. הרשומות שייכות לחשבונות. |
תגובה |
הוא משמש להפניה לישות Comment/Note ב-CRM. יכול להיות שבמערכת ה-CRM שלכם יש שם אחר לישות הזו. התגובות שייכות לרשומות. |
הגדרות API
בקטע הזה מפורטות ההגדרות שספציפיות להגדרות של CRM API בהתאמה אישית.
שיטת אימות
פלטפורמת CCAI תומכת בשלוש שיטות אימות למערכת ה-CRM:
אימות בסיסי: הגדרת פרטי אימות שכוללים שם משתמש וסיסמה.
כותרת בהתאמה אישית: מגדירים צמדים של מפתח/ערך של כותרת בהתאמה אישית: מפתח שדה וערך שדה. מזינים כמה זוגות שרוצים.
OAuth: פלטפורמת CCAI תומכת בפרוטוקול OAuth 2.0 שהוא תקן בתעשייה לאישור הרשאות. מציינים את פרטי OAuth אם צריך להפעיל את האפשרות Include the Redirect URL as part of the Authorization URL and Token URL (הכללת כתובת ה-URL להפניה אוטומטית כחלק מכתובת ה-URL של ההרשאה ומכתובת ה-URL של האסימון).
מגדירים את הערכים הבאים:
כתובת URL להרשאה (חובה)
כתובת URL של טוקן (שדה חובה)
מזהה לקוח (חובה)
סוד לקוח (חובה)
היקף
מדינה
סוג הגישה
הפורמט של מספר הטלפון
בוחרים את פורמט מספר הטלפון שבו רוצים להשתמש בבקשות ל-CRM:
אוטומטי: יצירה: +1 222 333 4444, חיפוש: *222*333*4444
E.164: +12223334444
ארה"ב מקומי: 2223334444
תקן מקומי בארה"ב: (111) 222-3333
כל העולם: +1 222 333 4444
פסק זמן לבקשת API
מגדירים את הזמן הקצוב לתפוגה של בקשת ה-API מ-1 עד 10 שניות באמצעות התפריט הנפתח. ההגדרה הזו של הזמן הקצוב לתפוגה תחול על כל נקודות הקצה שתגדירו.
כתובות URL לחיפוש ב-CRM
מציינים כתובות URL של חיפוש שישמשו להפניית סוכן לחשבון ולרשומה הנוכחיים.
מזינים כתובות URL של חיפושים כמו שהן מופיעות במערכת ה-CRM כשפותחים דף של חשבון או רשומה בדפדפן.
אפשר גם להשתמש בכתובות URL של חיפוש במערכת CRM עם web SDK ועם mobile SDKs. אתם יכולים להגדיר את ה-SDK כך שיחפש פרטים על חשבון CRM ופרטי רשומה כדי להציג אותם במתאם של הנציג. רשימה מלאה של כתובות URL של חיפושים במערכת CRM זמינה במאמר בנושא פרמטרים של כתובות URL של בקשות.
כתובת URL לחיפוש חשבון
משתמשים במשתנה {ACCOUNT_ID} כדי להוסיף את מזהה החשבון בפועל.
דוגמה:
https://www.example.com/contact/{ACCOUNT_ID}
כתובת URL לחיפוש רשומה
משתמשים במשתנה {RECORD_ID} כדי להוסיף את מזהה הרשומה בפועל.
לדוגמה:
https://www.example.com/record/{RECORD_ID}
נקודות קצה ל-API
זו ההגדרה הכי חשובה ל-Generic API.
כדי שהסוכנים יוכלו לחפש חשבונות, צריך להגדיר את נקודות הקצה (endpoints) של Find an account (חיפוש חשבון) ו-Create an account (יצירת חשבון).
בנוסף, אתם יכולים להגדיר נקודות קצה של Find a record ו-Create a record כדי לאפשר לסוכנים שלכם לחפש רשומות או ליצור אותן. כדי לעשות את זה, צריך להגדיר את החשבון כמו שמתואר בשלב הקודם.
לבסוף, אם מזינים נקודות קצה של עדכון רשומה, העלאת קובץ ותגובה, יופעל עדכון רשומות. כדי לעשות את זה, צריך להשתמש בהגדרות הרשומה מהשלב הקודם.
הגדרת נקודת הקצה
מגדירים את ההגדרות הבאות:
כתובת URL של בקשה: כתובת URL של נקודת קצה של ממשק API.
בוחרים את שיטת הבקשה מתוך POST, GET, PUT או PATCH.
מציינים את הפרמטרים של הבקשה. אפשר להשתמש במשתנים שמוגדרים ב-CCAI Platform כדי להעביר את המידע הנדרש (ראו את הטבלה שלמטה). בנוסף, אפשר להזין טקסט פשוט או מספרים כערכים של פרמטרים. אפשר להוסיף כמה פרמטרים שרוצים.
אם נקודת הקצה היא POST/PUT/PATCH, פלטפורמת CCAI מציעה אמצעי בקרה מדויקים יותר לגבי אופן בניית הבקשה. בוחרים באפשרות בקשת פורמט נתונים מתוך נכס או מאגר תגים. הוא מציין את הפורמט של ה-JSON של הבקשה.
נכס. המשמעות היא שאובייקט הבקשה הוא מפת מאפיינים בסיסית כש-CCAI Platform יוצר את גוף הבקשה מפרמטרים.
Container. הערך הזה מציין שנתוני אובייקט הבקשה שצריך לשלוח צריכים להיות מוטמעים במבנה. בוחרים באפשרות Container Type (סוג המאגר) מתוך Map (מפה) או Array (מערך). מזינים שם מאגר תגים. הוא משמש כשם אובייקט האב כשיוצרים את גוף הבקשה מפרמטרים.
דוגמה: מיפוי: { container_name : { ...parameters } }
דוגמה: מערך: {container_name : [ { ...parameters } ] }
מזינים את מיקום נתוני התגובות. הוא משמש לאיתור אובייקט התגובה של היעד בתגובת ה-JSON.
פרמטרים של כתובת URL של הבקשה
| פרמטר | משתנה | תגובה |
|---|---|---|
| מזהה הסוכן | {AGENT_ID} |
המזהה הפנימי של הסוכן. |
| מזהה מותאם אישית של הסוכן | {AGENT_CUSTOM_ID} |
שדה אופציונלי מהפרופיל של המשתמש. |
| כתובת האימייל של הנציג | {AGENT_EMAIL} |
כתובת האימייל של הסוכן שענה (אם רלוונטי). |
| שם משתמש הקצה | {NAME} |
|
| השם הפרטי של משתמש הקצה | {FIRST_NAME} |
נלקח מ-Name |
| שם המשפחה של משתמש הקצה | {LAST_NAME} |
הערך נלקח מ-Name. אם הערך חסר, ברירת המחדל היא --. |
| מזהה חיצוני | {UJET_ID} |
מזהה משתמש הקצה ב-CCAI Platform |
| אימייל | {EMAIL} |
|
| סוג השיחה/סוג הסשן | {SESSION_TYPE} |
|
| מספר הטלפון של משתמש הקצה | {PHONE_NUMBER} |
מעוצב לפי בחירת ההגדרה |
| מזהה שיחה | {Call_ID} |
מזהה השיחה ב-CCAI Platform. |
| מספר המזהה בצ'אט | {Chat_ID} |
מזהה הצ'אט ב-CCAI Platform. |
| שפה | {LANG} |
|
| מזהה משתמש מותאם אישית | {CUSTOM_USER_ID} |
בנייד: בצד ימין של האימייל. לדוגמה, test.user3 מתוך test.user3@test.co |
| מספר חשבון | {ACCOUNT_ID} |
החיפוש מתבצע על ידי קריאה לנקודת הקצה Find/Create contact. |
| מזהה הרשומה | {RECORD_ID} |
הערך נמצא על ידי קריאה לנקודת הקצה Find/Create record. |
| מזהה הסשן | {SESSION_ID} |
מזהה הסשן בפלטפורמת CCAI |
| נתיב בתפריט | {MENU_PATH} |
|
| מספר טלפון לשיחות יוצאות | {OUTBOUND_PHONE_NUMBER} |
מעוצב לפי בחירת ההגדרה |
| שם התור | {QUEUE_NAME} |
|
| מזהה התור | {QUEUE_ID} |
מזהה התור הפנימי. |
| שם ה-SDK | {SDK_NAME} |
שם משתמש הקצה כפי שמצוין ב-Web SDK או ב-Mobile SDK. |
| כתובת אימייל של SDK | {SDK_EMAIL} | כתובת האימייל של משתמש הקצה, כפי שמצוין ב-Web SDK או ב-Mobile SDK. |
| SDK Phone | {SDK_PHONE} | מספר הטלפון של משתמש הקצה, כפי שמצוין ב-Web SDK או ב-Mobile SDK. |
| מזהה ה-SDK | {SDK_IDENTIFIER} |
מזהה משתמש קצה או חשבון ב-SDK לאינטרנט או לנייד. אין לכלול פרטים אישיים מזהים (PII) בנכס הזה. כשיוצרים חשבון, צריך לציין את המזהה הזה בבקשה. |
| מזהה הסשן של פעולה חכמה | {SMART_ACTION_SESSION_ID} |
|
| פעולה חכמה: אימות | (בקרוב) | |
| פעולה חכמה: קלט טקסט | (בקרוב) | |
| דירוג | {RATING} |
האפשרות זמינה רק אם משתמש השאיר אותה |
| הודעת משוב | {FEEDBACK} |
האפשרות זמינה רק אם משתמש השאיר אותה |
| משך שיחה | {CALL_DURATION} |
בפורמט mm:ss |
| זמן ההמתנה | {HOLD_TIME} |
בפורמט mm:ss |
| זמן המתנה | {WAIT_TIME} |
בפורמט mm:ss |
| משך העבודה בעקבות השיחה | (בקרוב) | |
| סוג המכשיר | {DEVICE_TYPE} |
|
| התנתקות על ידי | {DISCONNECTED_BY} |
|
| ערוץ | {CHANNEL} |
|
| נושא הרשומה | {TICKET_SUBJECT} |
משמש כשם הרשומה |
| תיאור הרשומה | {TICKET_DESCRIPTION} |
|
| תיאור הרשומה ב-HTML | {TICKET_DESCRIPTION_HTML} |
זהה לתיאור, רק בפורמט HTML |
| גוף התגובה | {COMMENT_BODY} |
המדד הזה זמין רק במקרים שבהם מוסיפים תגובה (שמירת דירוג, סיום שיחה או צ'אט, התחלת שיחה או צ'אט) |
| נתוני קבצים | {FILE_DATA} |
האפשרות הזו זמינה רק בנקודת הקצה של קובץ ההעלאה, אבל היא מכילה את נתוני ה-base64 או את הנתונים של טופס multipart. |
פונקציות של פרמטרים של כתובות URL של בקשות
יש פונקציות שיכולות לעזור לכם עם משתנים דינמיים של פלטפורמת CCAI. אפשר להשתמש בפונקציות האלה רק בקטע Request Parameter (פרמטר בקשה) בהגדרות של נקודת הקצה.
הערך שיתקבל מפונקציה יהיה מחרוזת. אם הפונקציה לא מחזירה ערכים, הפרמטר מוסר מרשימת הפרמטרים בבקשה לפני ההפעלה.
| תפקיד | תחביר הפונקציה | תיאור |
|---|---|---|
| ערך ברירת המחדל | =DEFAULT_VALUE(val1, val2) |
הערך יהיה val1 אלא אם הוא null או ריק, ובמקרה כזה ברירת המחדל תהיה val2. |
שרשור Or | =CONCAT_OR(val1, val2,
val3) | שרשור של כמה ערכים עם or. דוגמה: 'val1 or val2 or val3' |
שרשור And | =CONCAT_AND(val1, val2,
val3) | שרשור של כמה ערכים עם and. דוגמה: 'val1 and val2 and val3' |
דוגמאות
בהמשך מופיעות כמה דוגמאות לשימוש בפונקציית הפרמטר של כתובת ה-URL של הבקשה.
ברירת מחדל
בדוגמה הבאה נעשה שימוש ב-DEFAULT_VALUE ב-Create a Record Endpoint.
המפתח והערך של הגדרת הסוכן משתמשים בפונקציית ברירת המחדל כדי לספק חלופה במקרה של ערך ריק בכתובת האימייל של הסוכן. יכול להיות ששדה האימייל של הנציג יהיה ריק ברשומה שנוצרת מכמה סיבות: יכול להיות שהלקוח סיים את השיחה במערכת לניתוב שיחות לפני שנציג שהוקצה ענה לשיחה הנכנסת, או שבמקרה של צ'אטים, הרשומה נוצרת לפני שנציג עונה. כך, יכול להיות שפרמטרים נדרשים יקבלו ערכי ברירת מחדל בטוחים עד לעדכונים מאוחרים יותר, או שהם יוגדרו במקרים של שיחות שהופסקו.

שרשור
בדוגמה הבאה נעשה שימוש ב-CONCAT_OR בנקודת הקצה Find an Account by Query. הדוגמה הזו ספציפית ל-Zoho CRM, אבל היא מראה איך אפשר להשתמש ב-CONCAT_OR. הפונקציה CONCAT_AND פועלת לפי אותם כללים, אבל מחברת בין הערכים באמצעות and במקום or. במקרים הבאים מפורטים הערכים שמופיעים בנקודת הקצה בזמן ההפעלה והערך שמועבר כפרמטר של הבקשה.

| מפתחות קיימים | הערך שמתקבל |
|---|---|
ACCOUNT_ID |
(Id:equals:<uuid>) |
ACCOUNT_ID, EMAIL |
(Id:equals:<uuid>) או (Email:equals:kim@example) |
PHONE_NUMBER, EMAIL |
(Phone:equals:+12223334444) או (Email:equals:kim@example) |
חשבון API
נקודות הקצה של חשבונות ב-API תומכות בשילוב עם חשבונות ב-CRM.
מתבצע ניסיון חוזר לקריאות לנקודות קצה שמחזירות שגיאת 400. לא מתבצע ניסיון חוזר לשיחות שמחזירות שגיאות אחרות. המערכת תמשיך לנסות לשלוח את הבקשות במשך שבוע, עם ירידה הדרגתית אקספוננציאלית. מידע על תהליכי API מופיע במאמר Custom CRM generic API: Flows.
איתור חשבון באמצעות נקודת קצה של שאילתה (לשעבר נקודת קצה לאיתור חשבון)
נקודת הקצה הזו משמשת לאיתור חשבון לפי מספר טלפון, כתובת אימייל או מזהה CRM פנימי. זוהי נקודת הקצה שמוגדרת כברירת מחדל לחיפוש חשבון.
דוגמה לתגובה:
{
"id": 123,
"name": "Kim",
"phone": "11234567890",
"email": "Kim@agents.co"
}
חיפוש חשבון לפי נקודת קצה של מזהה
נקודת הקצה הזו משמשת למציאת חשבון לפי מזהה. בדרך כלל, המזהה הזה הוא חלק מכתובת ה-URL. באימות כתובת ה-URL נבדק גם אם כתובת ה-URL לא נוצרה עם המזהה, ואם זה המצב, נקודת הקצה הזו לא תשמש. הפעולה הזו תתבצע בהתאם לסטנדרטים של REST. אם מוחזרת שגיאת 404 בחיפוש שנכשל, יתבצע חיפוש לפי שאילתה.
דוגמה לתגובה:
{
"id": 123,
"name": "Kim",
"phone": "11234567890",
"email": "Kim@agents.co"
}
יצירת נקודת קצה של חשבון
נקודת הקצה הזו משמשת ליצירת חשבון אם לא נמצא חשבון. ברוב מערכות ה-CRM, צריך לצרף רשומות לחשבונות. כדי ליצור תהליך אחיד, אנחנו אוכפים את הדרישה הזו בכל מערכות ה-CRM.
רשומת API
נקודות הקצה (endpoints) של רשומות ה-API מאפשרות שילוב עם רשומות או בקשות תמיכה במערכת ה-CRM.
חיפוש רשומה באמצעות שאילתה (לשעבר נקודת קצה לחיפוש רשומה)
נקודת הקצה הזו משמשת למציאת רשומה לפי קריטריון. בדרך כלל משתמשים בזה כדי למצוא רשומות שמשויכות לחשבון. אם פלטפורמת ה-CCAI מוגדרת לשימוש חוזר ברשומות קיימות, המערכת תשתמש ברשומה שנמצאה. זוהי נקודת הקצה שמוגדרת כברירת מחדל לחיפוש רשומה.
דוגמה לתגובה:
{
"id": 456,
"subject": "Record title",
"status": "open", // enumerated status open/closed, or 1,2,3
"contactId": 123, // contact attached to ticket
"phone": "11234567890", // contact phone
}
יצירת נקודת קצה של רשומה
נקודת הקצה הזו משמשת ליצירת רשומה. רשומה חדשה נוצרת אם לא נמצאה רשומה בבקשה Find a record או אם פלטפורמת CCAI מוגדרת כך שלא נעשה שימוש חוזר ברשומות קיימות.
דוגמה לבקשה:
{
"id": 123,
"subject": "Record title",
"description": "A longer description of the record, can be formatted in html",
"phone": "11234567890", // can be saved in multiple formats
"contactId": 123,
"sourceType": "PHONE", // PHONE/CHAT
"menu": "queue1",
"direction": "outgoing",
"rating": 5, // 1-5 scale
"feedback": "the agent was great!" // description of rating
}
עדכון נקודת קצה של רשומה
נקודת הקצה הזו משמשת לעדכון רשומה. הוא מעדכן את השם והתיאור של הרשומה. נקודת הקצה הזו יכולה גם לעדכן את הרשומה בהתאם לאירועים בפלטפורמת CCAI, כמו שמירת דירוג שביעות רצון לקוחות (CSAT), אירועים של סיום שיחה או צ'אט, תורים נבחרים, אימות משתמשים ועוד.
העלאה של נקודת קצה של קובץ
נקודת הקצה הזו משמשת להעלאת קובץ מצורף.
בוחרים את הסוג של נקודת הקצה להעלאה
טופס בקידוד Base64
טופס מרובה חלקים
בחירת הקבצים לצירוף
הקלטות של שיחות
תמלילי צ'אט
הודעות קוליות
Photos
סרטונים
קובץ מטא-נתונים של סשן
בוחרים באפשרות סוג הקובץ המצורף מתוך מזהה וכתובת URL של קובץ מצורף. הוא מציין את פורמט ה-JSON של התשובה.
מזהה
מזהה הקובץ המצורף. מזינים את המיקום של פרמטר בתגובת JSON למזהה של הקובץ המצורף. הוא יהיה זמין לכתובת ה-URL של כלי ליצירת קבצים מצורפים בתור {ATTACHMENT_ID}.
כתובת ה-URL של הכלי ליצירת קבצים מצורפים. מזינים את כתובת ה-URL להורדת הקובץ המצורף. המשתנים RECORD_ID ו-ATTACHMENT_ID זמינים.
לדוגמה:
https://www.example.com/Accounts/{RECORD_ID}/Attachments/{ATTACHMENT_ID}כתובת URL של קובץ מצורף
מזינים את המיקום של פרמטר בתגובת JSON עבור כתובת ה-URL להורדת הקובץ.
אם רוצים ש-CCAI Platform יוסיף תגובה לרשומה כשמעלים קובץ, מסמנים את התיבה Add comment to CRM (הוספת תגובה ל-CRM). ההגדרה Text Format (פורמט טקסט) מנקודת הקצה של התגובות תכובד לגבי התגובות האלה.
הדוגמה הבאה היא של טופס מרובה חלקים באמצעות POST/PUT/PATCH:
{
"file": <file data>
"id": 123, // optional, this can also just be part of the URL;
// for example https://example-customer.com/upload/record/{RECORD_ID}
}
דוגמה לתגובה:
דוגמה א': קיימת כתובת URL להורדה
{
"id": 123,
"url": "https://some-hosted-url.com"
}
דוגמה ב'
במקרה הזה, לא קיימת כתובת URL להורדה, אבל יש נקודת קצה (endpoint) של קובץ מצורף להורדה שמשתמשת במזהה הזה. לדוגמה, https://www.customer-api.com/record/{RECORD_ID}/Attachments/{ATTACHMENT_ID}.
{
"id": 123
}
נקודת הקצה של התגובה
נקודת הקצה הזו משמשת להוספת תגובה לרשומה. אם נקודת הקצה מוגדרת, פלטפורמת CCAI Platform תוסיף הערות לרשומות עם האירועים:
התחלת שיחה או צ'אט
סיום השיחה או הצ'אט
דירוג ותגובה בסקר שביעות רצון
חבילת נתונים בהתאמה אישית
העברת תגובות
קוד הטיפול והערות
שאלות ותשובות בסקר
בוחרים באפשרות פורמט טקסט לתגובות. אם תיבת הסימון המרת טקסט ל-HTML מסומנת, הטקסט יהיה בפורמט HTML. אחרת, הוא יהיה בפורמט טקסט רגיל.
בקשה לדוגמה, POST/PUT/PATCH:
{
"comment": "Some text",
// string can also be formatted on ujet side as html
"id": 123,
// optional, this can also just be part of the URL;
// for example https://example-customer.com/comment/record/{RECORD_ID}
}
Custom CRM generic API: Flows
בקטע הזה מופיעים תרשימי זרימה של זרימות API גנריות של CRM בהתאמה אישית.
תרשימי זרימה בסיסיים

איתור או יצירה של תהליך יצירת חשבון

איך מוצאים או יוצרים רשומת זרימה

רצף פעולות אחרי שיחה או צ'אט

עדכון של רצף פעולות של רשומה

זרימת התגובות

תהליך העלאת קובץ

מתאמים של סוכנים
מערכת CRM בהתאמה אישית מציעה שיטה כללית לשילוב מתאמים (ווידג'טים של ממשק משתמש) במערכות CRM. מערכת ה-CRM צריכה להיות מסוגלת לטפל באופן ההפעלה וההפעלה של המתאמים בתוכה.
כדי לשלב מתאמים של ממשק משתמש, בדרך כלל נדרשת תוכנה או אפליקציה של מערכת לניהול קשרי לקוחות (CRM). אנחנו כבר מספקים את היכולת הזו לכמה תוכנות CRM, כמו Salesforce, Kustomer, Zendesk ועוד.
iFrame
אפשר לשלב את מתאמי הסוכנים בצורה חלקה במערכת CRM או בכל כלי אחר באמצעות תג iFrame. מידע נוסף על תג iframe של HTML זמין במאמר בנושא תג iframe של HTML.
עם זאת, מערכת ה-CRM צריכה לנהל את האופן שבו המתאמים מוצגים למשתמש. לדוגמה, יכול להיות שיופיעו כפתורים בממשק המשתמש שיאפשרו להציג ולהסתיר את המתאמים. בנוסף, אפשר לעצב את המתאמים כך שיהיה אפשר לגרור אותם, וכך הסוכן יוכל לשנות את המיקום שלהם על המסך מתי שנוח לו. בדוגמאות הבאות אפשר לראות את הפורמט של כתובות URL.
מתאם שיחות:
https://tenant.loc.ccaiplatform.com/agent/?type=call&from=custom
מתאם צ'אט:
https://tenant.loc.ccaiplatform.com/agent/?type=chat&from=custom
תבנית iFrame
מתאם שיחות:
html
<iframe src="https://tenant.loc.CCAI Platformlatform.com/agent/?type=call&from=custom" allow="microphone; camera; geolocation" width="290" height="600"></iframe>
מתאם צ'אט:
html
<iframe src="https://tenant.loc.CCAI Platformlatform.com/agent/?type=chat&from=custom" allow="microphone; camera; geolocation" width="450" height="590"></iframe>
פרמטרים של כתובת URL
אפשר להשתמש בפרמטרים של כתובת URL כדי לספק לתוכנה מידע נוסף, כמו סוג האינטראקציה (שיחה או צ'אט), מקור האינטראקציה (מותאם אישית) ופרטים רלוונטיים אחרים.
אם הגדרת ה-CRM של הדייר לא זמינה ברשימות, הפרמטר From חייב להיות מוגדר תמיד לערך Custom.
סוג
- התקשרות
- צ'אט
מכיוון
- מותאם אישית (ההגדרה הזו צריכה להיות זהה להגדרת ה-CRM של הדייר). הערך צריך להיות תמיד custom לכל מערכת CRM שלא מופיעה ברשימות. אם לא מוגדר CRM, אפשר לדלג על הפרמטר הזה.
אירועים במתאמי סוכנים
מתאמי הסוכנים מפרסמים אירועים שאפשר לחבר למערכת ה-CRM, ואז המערכת מעבדת את העדכונים ב-CRM. כדי לעשות זאת, המערכת לניהול קשרי לקוחות צריכה להאזין לפוסטים מחלון האב ולקרוא את נתוני הפוסט. על סמך הנתונים, המערכת יכולה להפעיל פעולות כמו פתיחת כרטיסייה של כרטיס תמיכה למזהה סשן ספציפי.
גם למתאם השיחות וגם למתאם הצ'אט יש אירועים ספציפיים שאפשר להשתמש בהם כדי לשפר את היכולות של ה-CRM.
מתאם לשיחות
- שיחה חדשה
- הצנזורה של השיחה התחילה
- הצנזורה של השיחה הסתיימה
- סיום השיחה
מתאם לצ'אט
- שיחה חדשה
- צ'אט פעיל
- הודעה נכנסת בצ'אט
- הודעה יוצאת בצ'אט
- סיום השיחה
- שיחה שהוסרה
שני המתאמים
- התחברות לסוכן
- התחלת סשן של שיתוף מסך
- השליטה מרחוק בסשן של שיתוף המסך השתנתה
- הסשן של שיתוף המסך מלא, המכשיר השתנה
- הסשן של שיתוף המסך הסתיים
- העברה
- Party added
- הנציג מתחבר לסשן
- יציאה מהחשבון של הסוכן
- התווסף Agent Assist
נתונים של אירועים
call_id: מזהה של שיחה קולית נכנסת עם IVR (תגובה קולית אינטראקטיבית).
chat_id: מזהה של שיחה נכנסת בהודעות (צ'אט באינטרנט או בנייד).
cobrowse_session_id: מזהה של הפעלת שיתוף מסך. אפשר להתחיל שיתוף מסך בשיחה או בצ'אט.
session_type: סוג הסשן, כמו שיחה, צ'אט או הודעות.
va_data_parameters: כל המשתנים שהוגדרו בתור להעברה לסוכן הווירטואלי. הדרישה הזו רלוונטית רק לאירועים שקשורים לסוכן הווירטואלי. זה שינוי אופציונלי.
session_variable: כל המשתנים מהסוכן הווירטואלי שנשלחים לפלטפורמת CCAI במטען הייעודי (payload). זה שינוי אופציונלי.
custom_sip_headers: ההגדרה הזו מאפשרת להציג ביומן האירועים של בקשת ה-POST כותרות SIP מותאמות אישית משיחות SIP נכנסות. הפרמטר הזה נדרש רק אם משתמשים בכותרות SIP מותאמות אישית. זה שינוי אופציונלי.
custom_data_secured: מכיל נתונים מותאמים אישית מהשרת שלכם, שחתומים. זה שינוי אופציונלי.
custom_data_not_secured: מכיל נתונים מותאמים אישית לא חתומים מדף האינטרנט שלכם. מידע נוסף זמין במאמר בנושא נתונים מותאמים אישית לא חתומים ב-Chat. זה שינוי אופציונלי.
מזהי סוכנים
-
agent_id: מזהה של סוכן. -
from_agent_id: משמש להעברת שיחות או צ'אטים מנציג אחד לנציג אחר, כדי לציין את הנציג המקורי. -
to_agent_id: משמש להעברת שיחות או צ'אטים מנציג אחד לנציג אחר, כדי לציין את נציג היעד. -
agent_custom_id: זהו מזהה סוכן מפרופיל המשתמש, אם הוא הוזן בפרופיל. זה שינוי אופציונלי. -
from_agent_custom_id: משמש להעברת שיחות או צ'אטים מנציג אחד לנציג אחר, כדי לציין את הנציג המקורי. -
to_agent_custom_id: משמש להעברת שיחות או צ'אטים מנציג אחד לנציג אחר, כדי לציין את נציג היעד. -
agent_email: כתובת האימייל של הסוכן. -
from_agent_email: משמש להעברת שיחות או צ'אטים מנציג אחד לנציג אחר, כדי לציין את הנציג המקורי. -
to_agent_email: משמש להעברת שיחות או צ'אטים מנציג אחד לנציג אחר, כדי לציין את נציג היעד.
מזהים של סוכנים וירטואליים
-
virtual_agent_id: זהו מספר המזהה שהוקצה לסוכן וירטואלי ספציפי.
מזהי תור
-
queue_id: המזהה של תור ב-CCAI Platform, והוא קיים רק אם השיחה מגיעה מתור. -
from_queue_id: משמש לניתוב שיחות או צ'אטים מתור אחד לתור אחר, כדי לציין את התור המקורי. -
to_queue_id: משמש להפניית שיחות או צ'אטים מתור אחד לתור אחר, כדי לציין את תור היעד. -
queue_path: זהו הנתיב לתור ב-CCAI Platform, והוא קיים רק אם השיחה מגיעה מתור. -
from_queue_path: משמש לניתוב שיחות או צ'אטים מתור אחד לתור אחר, כדי לציין את התור המקורי. -
to_queue_path: משמש להפניית שיחות או צ'אטים מתור אחד לתור אחר, כדי לציין את תור היעד.
מזהה הקמפיין
-
campaign_id: מזהה הקמפיין ב-CCAI Platform. הם נכללים רק אם סוג השיחה הוא שיחה מקמפיין. -
campaign_name: שם הקמפיין ב-CCAI Platform. הם נכללים רק אם סוג השיחה הוא שיחה מקמפיין.
הודעה
-
message: אירוע שמציין שהתקבלה הודעה חדשה מצרכן, בתוספת תוכן ההודעה.
סוגי סשנים
-
session_type: סוג הסשן ב-CCAI Platform. -
cobrowse_session_remote_control: מציין את הסטטוס של בקשה להפעלת שיתוף מסך לשליטה מרחוק. ערכים:off, requested, rejected, on. -
cobrowse_session_full_device: מציין את הסטטוס של הפעלה של שיתוף מסך מלא של המכשיר. ערכים:off, requested, rejected, on.
משתתפים
type: סוג המשתתף –end_user;agent; (מתוך participants.type של תגובת /api/v1/calls או /api/v1/chats).
cobrowse_session_requested_by: מציין מי התחיל את הסשן של שיתוף המסך. הערכים האפשריים הםagentאוend_user.
cobrowse_session_ended_by: מציין מי סיים את הסשן של שיתוף המסך. ערכים אפשריים:agent,end_userאוapi.end_user_id:participants.end_user_idשל/api/v1/callsאו תגובה/api/v1/chats. השדה הזה מופיע רק אם הערך של type הואend_user.
סוגי אינטראקציות / סשנים
סוגי שיחות
- שיחות קוליות נכנסות: שיחות רגילות ב-PSTN.
- שיחות נכנסות ב-Voice (IVR באמצעות Mobile): שיחות PSTN חלופיות שמתבצעות מ-Mobile SDK.
- שיחות נכנסות (בנייד): מבוצעות על ידי צרכנים באמצעות SDK לנייד שהותקן.
- התקשרות חזרה (אינטרנט): מתבצעת מ-SDK לאינטרנט.
- קול נכנס (API): שיחה שהתחילה באמצעות API.
- הודעה קולית מתוזמנת (לנייד): מתוזמנת באמצעות SDK לנייד שהותקן.
- תזמון קולי (אינטרנט): תזמון באמצעות SDK מותקן לאינטרנט.
- שיחות יוצאות ב-Voice: שיחות שמתחילות על ידי נציג שמחייג למספר.
- שיחות יוצאות קוליות (API): שיחות שמופעלות באמצעות API.
- קמפיין קולי: קמפיין שמופעל באמצעות חיוגן לשיחות יוצאות.
סוגי צ'אטים
- הודעות (וואטסאפ): התחלתם את השיחה באמצעות וואטסאפ.
- הודעות נכנסות (SMS)
- הודעות יוצאות (SMS)
- הודעות יוצאות (SMS באמצעות API)
- הודעות (אינטרנט): מופעלות באמצעות SDK מותקן לאינטרנט.
- העברת הודעות (בנייד): מופעלת באמצעות SDK לנייד שהותקן.
סוג השיחה או הצ'אט
- סשן שיתוף מסך: סשן שמתחיל על ידי נציג או משתמש קצה במהלך שיחה או צ'אט.
סוגי אירועים
אלה סוגי האירועים שמתפרסמים על ידי מתאם הסוכן:
התחברות לסוכן
אירוע כניסה של סוכן מתרחש כשהסוכן מתחבר למתאם.
דוגמה לאירוע Agent_Login:
{
"type": "Agent_Login",
"data": {
"agent_id": 1,
"agent_custom_id": "007",
"agent_email": "Kim@example.com",
}
}
הנה תיאורים של השדות בנתוני האירועים:
agent_id: מזהה הסוכןאופציונלי:
agent_custom_id: המזהה המותאם אישית של הנציג, אם הוא הוזן בפרופיל של הנציג.
agent_email: כתובת האימייל שמשויכת לחשבון של הסוכן.
שיחה חדשה
אירוע חדש של שיחה מתרחש כשנציג עונה לשיחה. האירוע הזה מכיל מידע כמו מתי השיחה התחילה, איזה נציג טיפל בשיחה ומאיפה השיחה בוצעה.
דוגמה לאירוע New_Call:
{
"type": "New_Call",
"data": {
"agent_id": 1,
"agent_custom_id": "007",
"agent_email": "Kim@example.com",
"queue_id": 8469,
"queue_path": "Developers / Kim",
"campaign_id": 1432,
"campaign_name": "Survey Movie",
"call_id": 103646,
"session_type": "Voice Campaign (UJET)"
}
}
הנה תיאורים של השדות בנתוני האירועים:
agent_id: מזהה הסוכן
agent_custom_id: המזהה המותאם אישית של הסוכן, אם הוא הוזן בפרופיל של הסוכן. זה שינוי אופציונלי.
agent_email: כתובת האימייל שמשויכת לחשבון של הסוכן
queue_id: המזהה של התור שממנו בוצעה השיחה. השדה הזה כלול כשהשיחה הגיעה מתור. זה שינוי אופציונלי.
queue_path: הנתיב של התור שממנו בוצעה השיחה. השדה הזה נכלל כשהשיחה הגיעה מתור להמתנה. זה שינוי אופציונלי.
campaign_id: המזהה של הקמפיין. השדה הזה נכלל בשיחה של קמפיין. זה שינוי אופציונלי.
campaign_name: שם הקמפיין. השדה הזה נכלל בשיחה של קמפיין. זה שינוי אופציונלי.
call_id: מזהה השיחה
session_type: סוג הסשן
virtual_agent_id: המזהה של הנציג הווירטואלי. השדה הזה נכלל באירועים שקשורים לסוכן הווירטואלי. זה שינוי אופציונלי.
va_data_parameters: המשתנים שהוגדרו בתור להעברה לסוכן הווירטואלי. השדה הזה נכלל באירועים שקשורים לסוכן הווירטואלי. זה שינוי אופציונלי.
session_variable: כל המשתנים מהסוכן הווירטואלי שנשלחים אל Contact Center AI Platform. זה שינוי אופציונלי.
custom_sip_headers: מאפשר להציג כותרות SIP מותאמות אישית משיחות SIP נכנסות ביומן האירועים של POST. השדה הזה נכלל אם משתמשים בכותרות SIP בהתאמה אישית. זה שינוי אופציונלי.
custom_data_secured: מכיל נתונים מותאמים אישית חתומים מהשרת. זה שינוי אופציונלי.
custom_data_not_secured: מכיל נתונים מותאמים אישית לא חתומים מדף האינטרנט שלכם. מידע נוסף זמין במאמר בנושא נתונים מותאמים אישית לא חתומים ב-Chat. זה שינוי אופציונלי.
הצנזורה של השיחה התחילה
אירוע של התחלת צנזורה בשיחה מתרחש כשמתחילה צנזורה בשיחה ולא מתבצעת הקלטה. נתוני האירועים כוללים את המזהה של הנציג שטיפל בשיחה ואת מזהה השיחה.
-
agent_id: המזהה של הנציג שטיפל בשיחה -
call_id: המזהה של השיחה
דוגמה לאירוע של התחלת צנזורה של שיחה:
{
"agent_id": 2896,
"call_id": 97939
}
הצנזורה של השיחה הופסקה
האירוע 'הסתרת פרטים בשיחה הופסקה' מתרחש כשמסיימים להסתיר פרטים בשיחה וממשיכים את ההקלטה. האירוע הזה כולל את ID של הנציג שטיפל בשיחה ואת call ID.
-
agent_id:IDשל הסוכן שטיפל בשיחה -
call_id: הIDשל השיחה
דוגמה לנתוני אירועים של הפסקת צנזורה של שיחה:
{
"agent_id": 2896,
"call_id": 97939
}
סיום השיחה
אירוע של סיום שיחה מתרחש כששיחה מסתיימת. האירוע הזה מכיל מידע כמו מתי השיחה הסתיימה, איזה נציג טיפל בשיחה ומאיפה השיחה בוצעה.
דוגמה לאירוע End_Call:
{
"type": "End_Call",
"data": {
"agent_id": 1,
"agent_custom_id": "007",
"agent_email": "Kim@example.com",
"queue_id": 8469,
"queue_path": "Developers / Kim",
"campaign_id": 1432,
"campaign_name": "Survey Movie",
"call_id": 103646,
"session_type": "Voice Campaign (UJET)"
}
}
הנה תיאורים של השדות בנתוני האירועים:
agent_id: מזהה הסוכן
agent_custom_id: המזהה המותאם אישית של הסוכן, אם הוא הוזן בפרופיל של הסוכן. זה שינוי אופציונלי.
agent_email: כתובת האימייל שמשויכת לחשבון של הסוכן
queue_id: המזהה של התור שממנו בוצעה השיחה. השדה הזה כלול כשהשיחה הגיעה מתור. זה שינוי אופציונלי.
queue_path: הנתיב של התור שממנו בוצעה השיחה. השדה הזה נכלל כשהשיחה הגיעה מתור להמתנה. זה שינוי אופציונלי.
campaign_id: המזהה של הקמפיין. השדה הזה נכלל בשיחה של קמפיין. זה שינוי אופציונלי.
campaign_name: שם הקמפיין. השדה הזה נכלל בשיחה של קמפיין. זה שינוי אופציונלי.
call_id: מזהה השיחה
session_type: סוג הסשן
virtual_agent_id: המזהה של הנציג הווירטואלי. השדה הזה נכלל באירועים שקשורים לסוכן הווירטואלי. זה שינוי אופציונלי.
va_data_parameters: המשתנים שהוגדרו בתור להעברה לסוכן הווירטואלי. השדה הזה נכלל באירועים שקשורים לסוכן הווירטואלי. זה שינוי אופציונלי.
session_variable: כל המשתנים מהסוכן הווירטואלי שנשלחים אל Contact Center AI Platform. זה שינוי אופציונלי.
custom_sip_headers: מאפשר להציג כותרות SIP מותאמות אישית משיחות SIP נכנסות ביומן האירועים של POST. השדה הזה נכלל אם משתמשים בכותרות SIP בהתאמה אישית. זה שינוי אופציונלי.
custom_data_secured: מכיל נתונים מותאמים אישית חתומים מהשרת. זה שינוי אופציונלי.
custom_data_not_secured: מכיל נתונים מותאמים אישית לא חתומים מדף האינטרנט שלכם. מידע נוסף זמין במאמר בנושא נתונים מותאמים אישית לא חתומים ב-Chat (אופציונלי). זה שינוי אופציונלי.
צ'אט חדש
אירוע חדש של צ'אט מתרחש כשנציג תמיכה מקבל שיחת צ'אט. האירוע הזה מציין מתי הצ'אט התחיל, והוא מכיל מידע כמו איזה נציג טיפל בצ'אט ומאיפה הצ'אט התחיל.
דוגמה לאירוע New_chat:
{
"type": "New_Chat",
"data": {
"chat_id": 73522,
"session_type": "messaging inbound (web chat)",
"agent_id": 1,
"agent_email": "ariel@example.com",
"queue_id": 7678,
"queue_path": "HB TEAM / Ariel"
}
}
הנה תיאורים של השדות בנתוני האירועים:
chat_id: מזהה הצ'אט
session_type: סוג הסשן
agent_id: מזהה הסוכן
agent_custom_id: המזהה המותאם אישית של הסוכן, אם הוא הוזן בפרופיל של הסוכן. זה שינוי אופציונלי.
agent_email: כתובת האימייל שמשויכת לחשבון של הסוכן.
queue_id: המזהה של התור שממנו בוצעה השיחה. השדה הזה כלול כשהשיחה הגיעה מתור. זה שינוי אופציונלי.
queue_path: הנתיב של התור שממנו בוצעה השיחה. השדה הזה כלול אם השיחה הגיעה מתור המתנה. זה שינוי אופציונלי.
custom_data_secured: מכיל נתונים מותאמים אישית חתומים מהשרת. זה שינוי אופציונלי.
custom_data_not_secured: מכיל נתונים מותאמים אישית לא חתומים מדף האינטרנט שלכם. מידע נוסף זמין במאמר בנושא נתונים מותאמים אישית לא חתומים ב-Chat (אופציונלי). זה שינוי אופציונלי.
סיום השיחה
אירוע של סיום צ'אט מתרחש כששיחת צ'אט מסתיימת. האירוע הזה מציין מתי הצ'אט הסתיים, והוא מכיל מידע כמו הנציג שטיפל בצ'אט ומקור הצ'אט.
דוגמה לאירוע End_Chat:
{
"type": "End_Chat",
"data": {
"chat_id": 73522,
"session_type": "Messaging Inbound (Web Chat)",
"agent_id": 1,
"agent_email": "ariel@example.com",
"queue_id": null,
"queue_path": null,
"agent_custom_id": null
}
}
הנה תיאורים של השדות בנתוני האירועים:
chat_id: מזהה הצ'אט.
session_type: סוג הסשן.
agent_id: מזהה הסוכן.
agent_custom_id: המזהה המותאם אישית של הסוכן, אם הוא הוזן בפרופיל של הסוכן. זה שינוי אופציונלי.
agent_email: כתובת האימייל שמשויכת לחשבון של הסוכן.
queue_id: המזהה של התור שממנו בוצעה השיחה. השדה הזה כלול כשהשיחה הגיעה מתור. זה שינוי אופציונלי.
queue_path: הנתיב של התור שממנו בוצעה השיחה. השדה הזה נכלל כשהשיחה הגיעה מתור להמתנה. זה שינוי אופציונלי.
custom_data_secured: מכיל נתונים מותאמים אישית מהשרת שלכם, שחתומים. זה שינוי אופציונלי.
custom_data_not_secured: מכיל נתונים מותאמים אישית לא חתומים מדף האינטרנט שלכם. מידע נוסף זמין במאמר בנושא נתונים מותאמים אישית לא חתומים ב-Chat (אופציונלי). זה שינוי אופציונלי.
צ'אט פעיל
אירוע פעיל של צ'אט מתרחש כשהסוכן עובר לכרטיסיית צ'אט במתאם הצ'אט.
דוגמה לאירוע Active_Chat:
{
"type": "Active_Chat",
"data": {
"chat_id": 73521,
"session_type": "messaging inbound (web chat)",
"agent_id": 1,
"agent_email": "ariel@example.com",
"queue_id": 7678,
"queue_path": "HB TEAM / Ariel"
}
}
הנה תיאורים של השדות בנתוני האירועים:
chat_id: מזהה הצ'אט
session_type: סוג הסשן
agent_id: מזהה הסוכן
agent_custom_id: המזהה המותאם אישית של הסוכן, אם הוא הוזן בפרופיל של הסוכן. זה שינוי אופציונלי.
agent_email: כתובת האימייל שמשויכת לחשבון של הסוכן.
queue_id: המזהה של התור שממנו בוצעה השיחה. השדה הזה כלול כשהשיחה הגיעה מתור. זה שינוי אופציונלי.
queue_path: הנתיב של התור שממנו בוצעה השיחה. השדה הזה נכלל כשהשיחה הגיעה מתור להמתנה. זה שינוי אופציונלי.
custom_data_secured: מכיל נתונים מותאמים אישית מהשרת שלכם, שחתומים. זה שינוי אופציונלי.
custom_data_not_secured: מכיל נתונים מותאמים אישית לא חתומים מדף האינטרנט שלכם. מידע נוסף זמין במאמר בנושא נתונים מותאמים אישית לא חתומים ב-Chat (אופציונלי). זה שינוי אופציונלי.
הודעה נכנסת בצ'אט
אירוע של הודעה נכנסת בצ'אט מציין שהתקבלה הודעה חדשה מלקוח. הוא כולל את תוכן ההודעה.
הנתונים של השדות הבאים מדווחים עבור אירוע של הודעה נכנסת בצ'אט:
chat_id: מזהה את סשן הצ'אט
session_type: מציין את סוג הסשן שנוצר, למשל הודעות נכנסות דרך צ'אט באתר
agent_id: מזהה את הסוכן שמטפל בסשן הצ'אט
agent_custom_id: השדה הזה קיים רק אם הפרופיל של הסוכן כולל מזהה מותאם אישית. זה שינוי אופציונלי.
agent_email: כתובת האימייל של הנציג שמטפל בשיחת הצ'אט. השדה הזה נכלל רק אם הצ'אט מגיע מתור. זה שינוי אופציונלי.
queue_id: המזהה של התור שממנו הגיעה שיחת הצ'אט. השדה הזה נכלל רק אם הצ'אט מגיע מתור.
queue_path: הנתיב של התור שממנו הגיעה שיחת הצ'אט. השדה הזה נכלל רק כשהצ'אט מגיע מתור.
message: אירוע שמציין שהתקבלה הודעה חדשה מצרכן, בתוספת תוכן ההודעה
custom_data_secured: מאפשרת העברה של נתונים מותאמים אישית ומאובטחים של SDK. זה שינוי אופציונלי.
custom_data_not_secured: מאפשרת העברה של נתונים מותאמים אישית של SDK לא מאובטח. זה שינוי אופציונלי.
דוגמה לאירוע Chat_Inbound_Message:
{
"type": "Chat_Inbound_Message",
"data": {
"chat_id": 73522,
"session_type": "messaging inbound (web chat)",
"agent_id": 1,
"agent_email": "ariel@example.com",
"queue_id": 7678,
"queue_path": "HB TEAM / Ariel",
"message" : "Can you help me with my order tracking number?"
}
}
הודעה יוצאת בצ'אט
אירוע של הודעה יוצאת בצ'אט מתרחש כשמתקבלת הודעה חדשה מלקוח. הוא כולל את תוכן ההודעה.
הנתונים של השדות הבאים מדווחים עבור אירוע של הודעה יוצאת בצ'אט:
chat_id: מזהה את סשן הצ'אט
session_type: מציין את סוג הסשן שנוצר, למשל הודעות נכנסות דרך צ'אט באתר
agent_id: מזהה את הסוכן שמטפל בסשן הצ'אט
agent_custom_id: השדה הזה נכלל רק אם לפרופיל של הסוכן יש מזהה בהתאמה אישית. זה שינוי אופציונלי.
agent_email: כתובת האימייל של הנציג שמטפל בשיחת הצ'אט. השדה הזה נכלל רק אם הצ'אט מגיע מתור. זה שינוי אופציונלי.
queue_id: המזהה של התור שממנו הגיעה שיחת הצ'אט. השדה הזה נכלל רק אם הצ'אט מגיע מתור.
queue_path: הנתיב של התור שממנו הגיעה שיחת הצ'אט. השדה הזה נכלל רק כשהצ'אט מגיע מתור.
message: האירוע מציין שהתקבלה הודעה חדשה מצרכן, בנוסף לתוכן ההודעה
custom_data_secured: מאפשרת העברה של נתונים מותאמים אישית ומאובטחים של SDK. זה שינוי אופציונלי.
custom_data_not_secured: מאפשרת העברה של נתונים מותאמים אישית של SDK לא מאובטח. זה שינוי אופציונלי.
דוגמה לאירוע Chat_Outbound_Message:
{
"type": "Chat_Outbound_Message",
"data": {
"chat_id": 73522,
"session_type": "messaging inbound (web chat)",
"agent_id": 1,
"agent_email": "ariel@example.com",
"queue_id": 7678,
"queue_path": "HB TEAM / Ariel",
"message" : "Please give me a moment to look up your account information"
}
}
שיחה שנסגרה
אירוע של סגירת צ'אט מתרחש כשהנציג סוגר את כרטיסיית הצ'אט במתאם הצ'אט.
דוגמה לאירוע Dismissed_Chat:
{
"type":"Dismissed_Chat",
"data":{"chat_id":73522,
"session_type":"Messaging Inbound (Web Chat)",
"agent_id":1,
"agent_email":"ariel@example.com"
}
}
הנה תיאורים של השדות בנתוני האירועים:
chat_id: מזהה הצ'אט
session_type: סוג הסשן
agent_id: מזהה הסוכן
agent_custom_id: המזהה המותאם אישית של הסוכן, אם הוא הוזן בפרופיל של הסוכן. זה שינוי אופציונלי.
agent_email: כתובת האימייל שמשויכת לחשבון של הסוכן
queue_id: המזהה של התור שממנו בוצעה השיחה. השדה הזה כלול כשהשיחה הגיעה מתור. זה שינוי אופציונלי.
queue_path: הנתיב של התור שממנו בוצעה השיחה. השדה הזה נכלל כשהשיחה הגיעה מתור להמתנה. זה שינוי אופציונלי.
custom_data_secured: מכיל נתונים מותאמים אישית חתומים מהשרת. זה שינוי אופציונלי.
custom_data_not_secured: מכיל נתונים מותאמים אישית לא חתומים מדף האינטרנט. מידע נוסף זמין במאמר בנושא נתונים מותאמים אישית לא חתומים ב-Chat (אופציונלי). זה שינוי אופציונלי.
התחלת סשן של שיתוף מסך
אירוע Screen Share session started מתרחש כשסוכן או משתמש קצה מתחילים סשן של שיתוף מסך. אפשר להתחיל סשן של שיתוף מסך במהלך שיחה או צ'אט. מידע נוסף זמין במאמר בנושא שיתוף מסך.
דוגמה לאובייקט JSON של אירוע התחלת שיתוף מסך:
{
"type": "Cobrowse_Session_Started",
"data": {
"agent_id": 5,
"chat_id": 791,
"cobrowse_session_id": "Y1zYY6XIYX4oapqpEz3qHw",
"cobrowse_session_requested_by": "agent",
"cobrowse_session_remote_control": "off",
"cobrowse_session_full_device": "off"
}
}
הנה תיאורים של השדות בנתוני האירועים:
agent_id: מזהה הסוכן.
call_id: המזהה של שיחה נכנסת בערוץ IVR (תגובה קולית אינטראקטיבית). השדה הזה נכלל אם הסשן של שיתוף המסך התחיל במהלך שיחה.
chat_id: המזהה של צ'אט נכנס בערוץ האינטרנט או הנייד. השדה הזה נכלל אם סשן שיתוף המסך התחיל במהלך צ'אט.
cobrowse_session_id: המזהה של הפעלת שיתוף המסך.
cobrowse_session_requested_by: מציין מי התחיל את הפעלת שיתוף המסך. הערכים האפשריים הםagentו-end-user.
cobrowse_session_remote_control: מציין את הסטטוס של הפעלת שיתוף מסך בשלט רחוק. הערכים הםon,rejected,requestedו-off.
cobrowse_session_full_device: מציין את הסטטוס של הפעלה של שיתוף מסך מלא של המכשיר. הערכים הםon,rejected,requestedו-off.
custom_data_secured: מכיל נתונים מותאמים אישית מהשרת שלכם, שחתומים. זה שינוי אופציונלי.
custom_data_not_secured: מכיל נתונים מותאמים אישית לא חתומים מדף האינטרנט. מידע נוסף זמין במאמר בנושא נתונים מותאמים אישית לא חתומים ב-Chat (אופציונלי). זה שינוי אופציונלי.
השליטה מרחוק בסשן של שיתוף המסך השתנתה
אירוע של שינוי בשליטה מרחוק בסשן של שיתוף מסך מתרחש כשסטטוס השליטה מרחוק בסשן של שיתוף מסך משתנה. האירוע הזה מציין את הסטטוס של סשן שיתוף המסך של השלט הרחוק. מידע נוסף זמין במאמר בנושא שיתוף מסך.
דוגמה לאובייקט JSON של אירוע Cobrowse_Session_Remote_Control_Changed:
{
"type": "Cobrowse_Session_Remote_Control_Changed",
"data": {
"agent_id": 5,
"chat_id": 791,
"cobrowse_session_id": "Y1zYY6XIYX4oapqpEz3qHw",
"cobrowse_session_remote_control": "requested"
}
}
הנה תיאורים של השדות בנתוני האירועים:
agent_id: מזהה הסוכן.
call_id: המזהה של שיחה נכנסת בערוץ IVR (תגובה קולית אינטראקטיבית). השדה הזה נכלל אם הסשן של שיתוף המסך התחיל במהלך שיחה.
chat_id: המזהה של צ'אט נכנס באתר או בערוץ לנייד. השדה הזה נכלל אם הסשן של שיתוף המסך התחיל במהלך צ'אט.
cobrowse_session_id: המזהה של סשן שיתוף המסך.
cobrowse_session_remote_control: מציין את הסטטוס של הפעלת שיתוף מסך בשלט רחוק. הערכים הםon,rejected,requestedו-off.
custom_data_secured: מכיל נתונים מותאמים אישית מהשרת שלכם, שחתומים. זה שינוי אופציונלי.
custom_data_not_secured: מכיל נתונים מותאמים אישית לא חתומים מדף האינטרנט. מידע נוסף זמין במאמר בנושא נתונים מותאמים אישית לא חתומים ב-Chat (אופציונלי). זה שינוי אופציונלי.
הסשן של שיתוף המסך מלא, המכשיר השתנה
אירוע של שינוי במצב של שיתוף מסך של מכשיר מלא מתרחש כשמשתנה הסטטוס של שיתוף מסך של מכשיר מלא. האירוע הזה מציין את הסטטוס של סשן שיתוף המסך של המכשיר כולו. מידע נוסף זמין במאמר בנושא שיתוף מסך.
דוגמה לאירוע Cobrowse_Session_Full_Device_Changed:
{
"type": "Cobrowse_Session_Full_Device_Changed",
"data": {
"agent_id": 5,
"cobrowse_session_id": "9-Kshrag-gn6ZSuIxoMtWQ",
"cobrowse_session_full_device": "rejected"
}
}
הנה תיאורים של השדות בנתוני האירועים:
agent_id: מזהה הסוכן.
call_id: המזהה של שיחה נכנסת בערוץ IVR (תגובה קולית אינטראקטיבית). השדה הזה נכלל אם הסשן של שיתוף המסך התחיל במהלך שיחה.
chat_id: המזהה של צ'אט נכנס באתר או בערוץ לנייד. השדה הזה נכלל אם סשן שיתוף המסך התחיל במהלך צ'אט.
Cobrowse_session_id: המזהה של סשן שיתוף המסך.
Cobrowse_session_full_device: מציין את הסטטוס של הפעלת שיתוף מסך מלא של המכשיר. הערכים הםon,rejected,requestedו-off.
custom_data_secured: מכיל נתונים מותאמים אישית חתומים מהשרת. זה שינוי אופציונלי.
custom_data_not_secured: מכיל נתונים מותאמים אישית לא חתומים מדף האינטרנט שלכם. מידע נוסף זמין במאמר בנושא נתונים מותאמים אישית לא חתומים ב-Chat (אופציונלי). זה שינוי אופציונלי.
הסשן של שיתוף המסך הסתיים
אירוע של התחלת שיתוף מסך מתרחש כשסוכן, משתמש קצה או ה-API מסיימים סשן של שיתוף מסך. מידע נוסף זמין במאמר בנושא הגדרת שיתוף מסך.
דוגמה לאירוע Cobrowse_Session_Ended:
{
"type": "Cobrowse_Session_Ended",
"data": {
"agent_id": 5,
"cobrowse_session_id": "9-Kshrag-gn6ZSuIxoMtWQ",
"cobrowse_session_requested_by": "end_user",
"cobrowse_session_ended_by": "agent",
"cobrowse_session_remote_control": "on",
"cobrowse_session_full_device": "rejected"
}
}
הנה תיאורים של השדות בנתוני האירועים:
agent_id: מזהה הסוכן.
call_id: המזהה של שיחה נכנסת בערוץ IVR (תגובה קולית אינטראקטיבית). השדה הזה נכלל אם הסשן של שיתוף המסך התחיל במהלך שיחה.
chat_id: המזהה של צ'אט נכנס באתר או בערוץ לנייד. השדה הזה נכלל אם סשן שיתוף המסך התחיל במהלך צ'אט.
cobrowse_session_id: המזהה של סשן שיתוף המסך.
cobrowse_session_ended_by: מציין מי סיים את הפעלת שיתוף המסך. הערכים הםagent, end-userו-api.
cobrowse_session_remote_control: מציין את הסטטוס של הפעלת שיתוף מסך בשלט רחוק. הערכים הםon,rejected,requestedו-off.
cobrowse_session_full_device: מציין את הסטטוס של הפעלת שיתוף מסך מלא של המכשיר. הערכים הםon,rejected,requestedו-off.
custom_data_secured: מכיל נתונים מותאמים אישית מהשרת שלכם, שחתומים. זה שינוי אופציונלי.
custom_data_not_secured: מכיל נתונים מותאמים אישית לא חתומים מדף האינטרנט שלכם. מידע נוסף זמין במאמר בנושא נתונים מותאמים אישית לא חתומים ב-Chat (אופציונלי). זה שינוי אופציונלי.
העברה
אירוע העברה מתרחש כששיחה או צ'אט מועברים. ההעברה יכולה להיות חמה או קרה.
שדות האירועים הבאים הם חלק מאירוע העברה.
chat_idאוcall_id: מזהה את השיחה או את סשן הצ'אט
session_type: מציין את סוג הסשן שנוצר, למשל הודעות נכנסות דרך צ'אט באתר
campaign_id: מזהה הקמפיין. השדה הזה מופיע רק אם סוג השיחה הוא שיחה מקמפיין. זה שינוי אופציונלי.
campaign_name: שם הקמפיין. השדה הזה מופיע רק אם סוג השיחה הוא שיחה מקמפיין. זה שינוי אופציונלי.
from_agent_id: משמש להעברת שיחות או צ'אטים מנציג אחד לנציג אחר, כדי לציין את הנציג המקורי
from_agent_custom_id: משמש להפניית שיחות או צ'אטים מסוכן אחד לסוכן אחר, כדי לציין את הסוכן המקורי. זה שינוי אופציונלי.
from_agent_email: משמש לניתוב שיחות או צ'אטים מסוכן אחד לסוכן אחר, כדי לציין את הסוכן המקורי
to_agent_id: משמש להעברת שיחות או צ'אטים מנציג אחד לנציג אחר, כדי לציין את נציג היעד
to_agent_custom_id: משמש להפניית שיחות או צ'אטים מסוכן אחד לסוכן אחר, כדי לציין את סוכן היעד. זה שינוי אופציונלי.
to_agent_email: משמש להעברת שיחות או צ'אטים מסוכן אחד לסוכן אחר, כדי לציין את סוכן היעד
from_queue_id: משמש להפניית שיחות או צ'אטים מתור אחד לתור אחר, כדי לציין את התור המקורי
from_queue_path: משמש להפניית שיחות או צ'אטים מתור אחד לתור אחר, כדי לציין את התור המקורי
to_queue_id: משמש להפניית שיחות או צ'אטים מתור אחד לאחר כדי לציין את תור היעד
to_queue_path: משמש להפניית שיחות או צ'אטים מתור אחד לאחר, כדי לציין את תור היעד
virtual_agent_id: המזהה שהוקצה לסוכן וירטואלי. זה שינוי אופציונלי.
va_data_parameters: כל המשתנים שהוגדרו בתור להעברה לסוכן הווירטואלי. הפרמטר הזה נדרש רק לאירועים שקשורים לסוכן הווירטואלי. זה שינוי אופציונלי.(
session_variable: כל המשתנים מהסוכן הווירטואלי שנשלחים לפלטפורמת CCAI במטען הייעודי (payload). זה שינוי אופציונלי.
custom_sip_headers: מאפשר להציג כותרות SIP מותאמות אישית משיחות SIP נכנסות ביומן האירועים של POST. הוא נדרש רק אם משתמשים בכותרות SIP בהתאמה אישית. זה שינוי אופציונלי.
custom_data_secured: מאפשרת העברה של נתונים מותאמים אישית ומאובטחים של SDK. זה שינוי אופציונלי.
custom_data_not_secured: מאפשרת העברה של נתונים מותאמים אישית של SDK לא מאובטח. זה שינוי אופציונלי.
דוגמה לאירוע העברה:
{
"type": "Transfer_Chat",
"data": {
"chat_id": 103646,
"session_type": "Messaging Inbound (SMS)",
"campaign_id": 1432,
"campaign_name": "Survey Movie",
"from_agent_id": 1,
"from_agent_custom_id": "007",
"from_agent_email": "Ira@example.com",
"to_agent_id" : 5
"to_agent_custom_id": "100"
"to_agent_email" : "ariel@example.com"
"from_queue_id": 8469,
"from_queue_path": "Developers / Ariel",
"to_queue_id" : 1234,
"to_queue_path" : "Schemes / Auric"
}
}
Party added
אירוע שנוסף לצדדים מתייחס לכל העברה. ההעברה יכולה להיות של שיחה או של צ'אט.
אירוע שנוסף על ידי צד שלישי מכיל את הנתונים הבאים:
chat_idאוcall_id: מזהה את השיחה או את סשן הצ'אט
session_type: מציין את סוג הסשן שנוצר, למשל הודעות נכנסות דרך צ'אט באתר
agent_custom_id: השדה הזה קיים רק אם הפרופיל של הסוכן כולל מזהה מותאם אישית. זה שינוי אופציונלי.agent_email: כתובת האימייל של הנציג שמטפל בשיחה או בצ'אט.
queue_id: המזהה של התור שממנו הגיעה שיחת הצ'אט. השדה הזה נכלל רק אם הצ'אט מגיע מתור. זה שינוי אופציונלי.
queue_path: הנתיב של התור שממנו הגיעה שיחת הצ'אט. השדה הזה נכלל רק כשהצ'אט מגיע מתור. זה שינוי אופציונלי.
campaign_id: מזהה הקמפיין. השדה הזה נכלל רק כשסוג השיחה הוא שיחה מקמפיין. זה שינוי אופציונלי.
campaign_name: שם הקמפיין. השדה הזה נכלל רק כשסוג השיחה הוא שיחה מקמפיין. זה שינוי אופציונלי.
type: סוג המשתתף, לדוגמה: end_user או agent. השדה הזה מוחזר כחלק מהשדה participants.type של תגובת/api/v1/callsאו/api/v1/chats
end_user_id: מזהה משתמש הקצה. השדה הזה מוחזר כחלק מהתשובה של/api/v1/callsאו/api/v1/chats. השדה הזה מופיע רק בשיחות או בצ'אטים עם משתמשי קצה שהועברו מנציג אחד לנציג אחר, כדי לציין את נציג היעד. זה שינוי אופציונלי.
virtual_agent_id: המזהה שהוקצה לנציג וירטואלי. זה שינוי אופציונלי.
va_data_parameters: כל המשתנים שהוגדרו בתור להעברה לסוכן הווירטואלי. הפרמטר הזה נדרש רק לאירועים שקשורים לסוכן הווירטואלי. זה שינוי אופציונלי.
session_variable: כל המשתנים מהסוכן הווירטואלי שנשלחים לפלטפורמת CCAI במטען הייעודי (payload). זה שינוי אופציונלי.
custom_sip_headers: האפשרות הזו מאפשרת להציג ביומן האירועים של בקשות POST כותרות SIP מותאמות אישית משיחות SIP נכנסות. הוא נדרש רק אם משתמשים בכותרות SIP בהתאמה אישית. זה שינוי אופציונלי.
custom_data_secured: מאפשרת העברה של נתונים מותאמים אישית ומאובטחים של SDK. זה שינוי אופציונלי.
custom_data_not_secured: מאפשרת העברה של נתונים מותאמים אישית של SDK לא מאובטח. זה שינוי אופציונלי.
דוגמה לאירוע Party_Added:
{
"type": "Party_Added",
"data": {
"chat_id": 103646,
"session_type": "Messaging Inbound (SMS)",
"campaign_id": 1432,
"campaign_name": "Survey Movie",
"agent_id": 1,
"agent_custom_id": "007",
"agent_email": "ariel@example.com",
"queue_id": 8469,
"queue_path": "Developers / Ariel",
"type" : "agent"
}
}
הנציג מתחבר לסשן
אירוע של נציג שמתחבר לסשן מתרחש כשנציג מתחבר לסשן. יש שני סוגים שונים של אירועים. הסוג נקבע לפי האם מדובר בשיחה או בצ'אט.
השדות הבאים של האירועים הם חלק מהאירוע agent connects to session.
agent_id: מזהה את הנציג שמטפל בשיחה או בצ'אט.agent_email: כתובת האימייל של הנציג שמטפל בשיחה או בצ'אט.
agent_custom_id: השדה הזה קיים רק אם הפרופיל של הסוכן כולל מזהה מותאם אישית. זה שינוי אופציונלי.
chat_idאוcall_id: מזהה את השיחה או את סשן הצ'אט.
virtual_agent_id: המזהה שהוקצה לסוכן וירטואלי ספציפי. זה שינוי אופציונלי.
campaign_id: מזהה הקמפיין. השדה הזה נכלל רק אם סוג השיחה הוא שיחה מקמפיין. זה שינוי אופציונלי.
campaign_name: שם הקמפיין. השדה הזה נכלל רק כשסוג השיחה הוא שיחה מקמפיין. זה שינוי אופציונלי.
queue_id: המזהה של התור שממנו הגיעה שיחת הצ'אט. השדה הזה נכלל רק אם הצ'אט מגיע מתור. זה שינוי אופציונלי.
queue_path: הנתיב של התור שממנו הגיעה שיחת הצ'אט. השדה הזה נכלל רק כשהצ'אט מגיע מתור. זה שינוי אופציונלי.
session_type: מציין את סוג הסשן שנוצר, למשל הודעות נכנסות דרך צ'אט באתר.
virtual_agent_id: המזהה שהוקצה לסוכן וירטואלי. זה שינוי אופציונלי.
va_data_parameters: כל המשתנים שהוגדרו בתור להעברה לסוכן הווירטואלי. הדרישה הזו רלוונטית רק לאירועים שקשורים לסוכן הווירטואלי. זה שינוי אופציונלי.
session_variable: כל המשתנים מהסוכן הווירטואלי שנשלחים אל UJET במטען הייעודי (payload). זה שינוי אופציונלי.
custom_sip_headers: האפשרות הזו מאפשרת להציג ביומן האירועים של בקשות POST כותרות SIP מותאמות אישית משיחות SIP נכנסות. הוא נדרש רק אם משתמשים בכותרות SIP בהתאמה אישית. זה שינוי אופציונלי.
custom_data_secured: מאפשרת העברה של נתונים מותאמים אישית ומאובטחים של SDK. זה שינוי אופציונלי.
custom_data_not_secured: מאפשרת העברה של נתונים מותאמים אישית של SDK לא מאובטח. זה שינוי אופציונלי.
דוגמה לנתוני אירוע Agent_Joined_Chat:
{
"type": "Agent_Joined_Chat",
"data": {
"chat_id": 103646,
"campaign_id": 1432,
"campaign_name": "Survey Movie",
"agent_id": 1,
"agent_custom_id": "007",
"agent_email": "ariel@example.com",
"queue_id": 8469,
"queue_path": "Developers / Ariel",
"session_type": "Messaging Inbound (SMS)",
}
}
יציאה מהחשבון של הסוכן
אירוע התנתקות של סוכן מתרחש כשסוכן מתנתק מהמתאם של הסוכן.
שדות האירועים הבאים הם חלק מאירוע Agent_Logout.
agent_id: המזהה של הסוכן שהתחבר
agent_email: כתובת האימייל שמשויכת לחשבון הסוכן
agent_custom_id: המזהה המותאם אישית של הנציג, אם הוא הוזן בפרופיל של הנציג. זה שינוי אופציונלי.
דוגמה לאירוע Agent_Logout:
{
"type": "Agent_Logout",
"data": {
"agent_id": 1,
"agent_custom_id": "007",
"agent_email": "ariel@example.com",
}
}
התחילה הפעלה של Agent Assist
אירוע של הפעלת Agent Assist מתרחש כשנציג מפעיל את Agent Assist במהלך שיחה או סשן צ'אט.
דוגמה לאירוע Agent_Assist_Started:
{
"type": "Agent_Assist_Started",
"data": {
"conversation_id": "12345",
"queue_id": "65",
"agent_id": "1",
"session_id": "78534G4RT4284",
"queue_language_id": "en",
"timestamp": "12:45:15"
}
}
אלה השדות של האירוע:
conversation_id: מזהה השיחה
queue_id: מזהה התור
agent_id: מזהה הסוכן
session_id: מזהה הסשן
queue_language_id: השפה של התור
timestamp: חותמת הזמן
חלון קופץ ברקע
היכולת להצגת מסך מאפשרת לסוכנים להציג מסך של מערכת CRM ברקע, כלומר מידע על הלקוח מוצג במסך של הסוכן בלי שהסוכן יצטרך לבצע פעולה כלשהי. כך הצרכנים נהנים מחוויה חלקה יותר, והסוכנים יכולים לטפל בפניות מהר יותר.
פתיחת רשומת CRM בחלון קופץ
האירוע CRM_Record_Pop הוא אירוע בצד השרת שמופעל כשצריך להציג כרטיס. האירוע הזה כולל פרמטר בשם recordUrl שמכיל את כתובת ה-URL של רשומת ה-CRM. כך אפשר להציג את המסך על ידי הרשמה לאירועי POST אם משתמשים במתאמים מוטמעים.
כדי לעשות את זה, בדוגמה הבאה מוסבר איך להוסיף פונקציית event listener שמקשיבה להודעות שנשלחות מפריים או מחלון אחרים. קטע הקוד הזה נועד לאפשר תקשורת בין מסגרות או חלונות שונים, ולאפשר עדכונים דינמיים של התוכן שמוצג ב-iframe על סמך הודעות שהתקבלו.
// name is the html property of the iframe
const iframeTarget = document.querySelector('iframe[name="target_iframe_adapter"]')
// example usage of add event listener
// https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener
window.addEventListener('message', (e) => {
try {
const data = JSON.parse(e.data)
const type = data.type
console.log('EventListener: ', JSON.stringify(data))
if (type === 'CRM_Record_Pop') {
const recordUrl = data.data.recordUrl
if (!recordUrl) {
return
}
console.log(`Opening <strong>recordUrl</strong> in iframe <strong>${iframeTarget.getAttribute('name')}</strong>`)
// changing an iframe target to the record URL pop
iframeTarget.src = recordUrl
} else if (type === 'New_Chat') {
console.log(`<strong>Chat started...</strong>`)
// handling here for new_chat events
} else if (type === 'End_Chat') {
console.log(`<strong>Chat ended...</strong>`)
// handling here for end_chat events
} if (.... //other event types) {
// code handling for other types
}else {
console.log(JSON.stringify(data))
}
} catch (e) {
log(e, true)
}
}, false)