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

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

סטטוס התור

הצגת נתונים בזמן אמת לגבי תורים בעלים, כולל זמני המתנה משוערים, זמינות של נציגים, קיבולת של משבצות לשיחות חוזרות, שעות פעילות וחגים. ההגדרה הזו מאפשרת למערכות 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 מספר שלם משך החלון העתידי הכולל בשעות שבו יוחזרו תקופות של משבצות זמן לחזרה ללקוח. הערך חייב להיות קטן מ-8 שעות או שווה לו. ברירת המחדל היא 4 שעות. זה שינוי אופציונלי.
callback_start_from מחרוזת תחילת חלון החיפוש של משבצת זמן לשיחה חוזרת, בפורמט ISO 8601 של תאריך ושעה בתור או באזור הזמן של החברה. אם לא מציינים את השעה, ברירת המחדל היא השעה הנוכחית (שעת השרת שהומרה לאזור הזמן של התור או של החברה). התאריך לא יכול להיות בעבר, והוא יכול להיות עד 24 שעות בעתיד. זה שינוי אופציונלי.

דוגמה לתשובה

{
    "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
                },
                {
                    "date": "20260225",
                    "start_time": "17:45",
                    "end_time": "18:00",
                    "scheduled_calls": 0,
                    "max_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
}