נקודת הקצה הזו ב-API מחזירה את זמן ההמתנה המשוער (EWT) המחושב לכל תור.
אפשר להשתמש בנתונים האלה כדי להציג זמני המתנה משוערים בערוצי תמיכה מותאמים אישית בדפי אינטרנט או באפליקציות לנייד מחוץ ל-SDK של Contact Center AI Platform (פלטפורמת CCAI), או כדי להציג התראות או טריגרים מותאמים אישית.
דוגמה לבקשה
כתובת URL: http://{subdomain}.{domain}/apps/api/v1/wait_times
פרמטרים
| מזהה | שם השדה | סוג | חובה | תיאור | ערכים | הערות |
|---|---|---|---|---|---|---|
| 1 | menu_id | id | לא | התשובה תסנן את כל התפריטים (תורים) בתפריט המשנה של התפריט הזה, כולל התפריט הזה | תפריט הבסיס (ברירת מחדל) תפריט ספציפי | אם לא מעבירים כלום, הפונקציה תחזיר את המבנה המלא של התור. |
| 2 | channel_type | enum | לא | מחזירה תפריטים של ערוץ ספציפי | voice_call chat | פרמטר אופציונלי |
| 3 | menu_type | enum | לא | תפריטי החזרות מסוגים ספציפיים | ivr_menu mobile_menu web_menu הכול (ברירת מחדל) |
אופציונלי |
| 4 | wait[from] | int | לא | הפונקציה מחזירה רשומות אם זמן ההמתנה שלהן גדול מהערך | אימות:מספר שלם חיובי בלבד | |
| 5 | wait[to] | int | לא | הפונקציה מחזירה רשומות אם זמן ההמתנה שלהן קטן מהערך | אימות:מספר שלם חיובי בלבד | |
| 6 | lang | enum | כן | מבנה התור לאחזור זמן ההמתנה המשוער | דוגמה: "en" "es" "fr" "de" "it" "ja" "ko" "pt" "pt-BR" "sv" |
תשובות
| מזהה | שם השדה | סוג | חובה | תיאור |
|---|---|---|---|---|
| 1 | menu_id | id | כן | מפתח זר לנקודת הקצה של ה-API של כלי הניהול /menus |
| 2 | המתנה | INT | כן | זמן ההמתנה בדקות |
| 3 | נתיב מהותי | String | כן | נתיב ממומש כפי שמופיע ב-API /menus |
דוגמה
http://{subdomain}.{domain}/apps/api/v1/wait_times?lang=en&menu_id=10
[
{
"menu_id": 10,
"menu_type": "ivr_menu",
"voice_call": 120,
"materialized_path": "Subscription",
"logged_in_agents": 3,
"available_agents": 0,
"breakthrough_agents": 1
}
]
קוד הסטטוס: 200
זמן ההמתנה המשוער בתפריט עם מזהה 10 הוא 120 שניות (או שתי דקות)