佇列端點

佇列狀態端點會傳回佇列資訊，以判斷是否要轉接通話。

佇列狀態

提供葉子佇列的即時資料，包括預估等待時間、服務專員空檔、預約回電時段容量、營業時間和節慶假日。使用這項功能，讓語音 AI 系統動態決定是否要將通話轉接給真人服務專員，或提供排定的回撥時間給來電者。詳情請參閱「佇列狀態端點」。

要求範例

方法：GET

網址：https://{subdomain}.{domain}/apps/api/v1/queues/status

標頭

鍵	值	說明
Content-Type	application/json
接受	application/json

查詢

鍵	值	說明
lang	字串	佇列的雙字母語言代碼，格式為 ISO 639-1 (例如 en 或 es)。必要欄位。
menu_id[]	字串	單一佇列 ID 或多個佇列 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

網址：https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses

查詢

鍵	值	說明
menu_id	整數	要取得空位資訊的佇列 ID。必填。
lang	字串	佇列的雙字母語言代碼，採 ISO 639-1 格式。必填。
channel_type	字串	管道類型。可能的值為 call 和 chat。必填。

回覆範例

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