נקודות קצה של תורים

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

סטטוס התור

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

דוגמה לבקשה

שיטה: GET

כתובת URL: https://{subdomain}.{domain}/apps/api/v1/queues/status

כותרות

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

שאילתה

מפתח	ערך	תיאור
lang	מחרוזת	קוד השפה בן שתי האותיות של התור, בפורמט ISO 639-1 (לדוגמה, en או es). חובה.
menu_id[]	מחרוזת	מזהה תור אחד או מערך של כמה מזהי תורים. חובה.
menu_type	מחרוזת	סוג התפריט. הערכים האפשריים הם ivr_menu,‏ mobile_menu ו-web_menu. חובה.
callback_period_hours	מספר שלם	משך הזמן הכולל בשעות שבו המערכת תחזיר משבצות זמן לשיחות חוזרות. הערך צריך להיות בין 1 ל-24. אם לא מציינים חלון זמן, המערכת משתמשת בחלון זמן של 4 שעות כברירת מחדל, אלא אם בחשבון שלכם מופעל תזמון לפי קיבולת. זה שינוי אופציונלי.
callback_start_from	מחרוזת	תחילת חלון החיפוש של משבצת הזמן לשיחה חוזרת, בפורמט תאריך ושעה של ISO 8601 באזור הזמן של התור או של החברה. אם לא מציינים את הפרמטר הזה, ברירת המחדל היא השעה הנוכחית (שעת השרת שמומרת לאזור הזמן של התור או של החברה). התאריך לא יכול להיות בעבר. זה שינוי אופציונלי.

דוגמה לתשובה

{
    "queues": [
        {
            "menu_id": 2,
            "menu_type": "ivr_menu",
            "lang": "en",
            "materialized_path": "IVR Support",
            "current_queue_ewt": 18000,
            "scheduled_callback_ewt": 0,
            "logged_in_agents": 0,
            "available_agents": 0,
            "breakthrough_agents": 0,
            "callback_periods": [
                {
                    "date": "20260225",
                    "start_time": "17:30",
                    "end_time": "17:45",
                    "scheduled_calls": 0,
                    "max_slots": 1,
                    "available_slots": 1
                },
                {
                    "date": "20260225",
                    "start_time": "17:45",
                    "end_time": "18:00",
                    "scheduled_calls": 0,
                    "max_slots": 1,
                    "available_slots": 1
                }
            ],
            "hoops": {
                "current_status": 0,
                "time_zone": "America/Los_Angeles",
                "start_of_hoops": "2026-02-25T09:00:00-08:00",
                "end_of_hoops": "2026-02-25T18:00:00-08:00",
                "hoops_early_cutoff_minutes": null
            },
            "holiday": {
                "current_status": 0,
                "holiday_name": null,
                "time_range_all_day": null,
                "time_range_start_time": null,
                "time_range_end_time": null,
                "time_zone": "America/Los_Angeles"
            }
        }
    ]
}

זמינות התור

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

• ‫after_hours: true אם התור לא זמין כי הוא במצב "מחוץ לשעות הפעילות"

• ‫overcapacity: true אם התור לא זמין כי הוא במצב של קיבולת יתר

דוגמה לבקשה

שיטה: GET

כתובת URL: https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses

שאילתה

מפתח	ערך	תיאור
menu_id	מספר שלם	המזהה של התור שרוצים לקבל מידע על הזמינות שלו. חובה.
lang	מחרוזת	קוד השפה בן שתי האותיות של התור, בפורמט ISO 639-1. חובה.
channel_type	מחרוזת	סוג הערוץ. הערכים האפשריים הם call ו-chat. חובה.

דוגמה לתשובה

{
  "menu_id": 1,
  "lang": "en",
  "channel_type": "call",
  "after_hour": false,
  "overcapacity": true
}