ב-Contact Center AI Platform (פלטפורמת CCAI) יש כמה נקודות קצה ל-API שתומכות בשילוב עם הפלטפורמה. ממשק ה-API של המנהל מרחיב את התכונות שקשורות להגדרות ולתצורה של המערכת, וגם לאירועים ולפעילויות.
נקודות הקצה של ה-API לניהול מתחלקות לכמה קבוצות:
סוכן: משאבים של סוכנים ספציפיים
פעילות של סוכן: בכל פעם שווידג'ט של סוכן משנה את סטטוס המשתמש או מקבל התראה
קמפיינים: האירועים שמשויכים לחייגן לשיחות יוצאות
שיחות: משאב שיחה יחיד
צ'אטים: משאב צ'אט יחיד
אימיילים: משאב אימייל יחיד
תפריט: התורים שהנציגים מוקצים אליהם ומשתמשי הקצה ניגשים אליהם כדי לקבל תמיכה מנציג.
צוות: הצוותים שהסוכן שייך אליהם
סטטוס המשתמש: סטטוסים שונים שבהם יכול להיות הווידג'ט של הנציג
אימות בסיסי
הבקשות משתמשות באימות בסיסי. כדי ליצור פרטי כניסה ל-API, פועלים לפי השלבים הבאים:
נכנסים לפורטל של CCAI Platform.
עוברים אל Settings (הגדרות) > Developer Settings (הגדרות למפתחים) > API Credentials (פרטי כניסה ל-API).
מוסיפים פרטי כניסה חדשים ל-API ונותנים להם שם.
אלה פרטי הכניסה לקריאות ל-API:
תת-הדומיין משמש כמשתנה
{username}.הטוקן משמש כמשתנה
{password}.
לכל התקנה יש תת-דומיין משלה. כדי למצוא את תת-הדומיין, מאתרים את כתובת ה-URL בדפדפן. הוא אמור להיראות כך:
https://customer.uc1.ccaiplatform.com
מחליפים את תת-הדומיין (customer, בדוגמה הזו) במשתנה \{subdomain\}. מחליפים את שאר כתובת ה-URL (rest.of.url.com, בדוגמה הזו) במשתנה \{domain\}.
כתובת URL בסיסית
ה-API משתמש בכתובת ה-URL הבסיסית הבאה לכל בקשות ה-API שלו
https://{subdomain}.{domain}/manager/api/v1
כאשר אזכור של /calls פירושו https://{subdomain}.{domain}/manager/api/v1/calls
מגבלות קצב
המערכת מגבילה את הבקשות לקצב של 10 בקשות לשנייה.