這個 API 端點會傳回每個佇列的預估等待時間 (EWT)。
這項功能可用於在 Contact Center AI Platform (CCAI Platform) SDK 以外的網頁或行動應用程式上，顯示自訂支援管道的預計等待時間，或用於自訂通知或觸發條件。
要求範例
網址：http://{subdomain}.{domain}/apps/api/v1/wait_times
參數
| ID | 欄位名稱 | 類型 | 必填 | 說明 | 值 | 附註 |
|---|---|---|---|---|---|---|
| 1 | menu_id | id | 否 | 回應會篩選該選單子選單中的所有選單 (佇列)，包括該選單 | 根層級選單 (預設) 特定選單 | 如果未傳遞任何內容，則會傳回整個佇列結構 |
| 2 | channel_type | 列舉 | 否 | 傳回特定頻道的菜單 | 語音通話 即時通訊 | 選用參數 |
| 3 | menu_type | 列舉 | 否 | 傳回特定類型的選單 | ivr_menu mobile_menu web_menu 全部 (預設) |
選用 |
| 4 | wait[from] | 整數 | 否 | 如果記錄的等待時間大於指定值，就會傳回記錄 | 驗證：僅限正整數 | |
| 5 | wait[to] | 整數 | 否 | 如果記錄的等待時間小於該值，則傳回記錄 | 驗證：僅限正整數 | |
| 6 | lang | 列舉 | 是 | 用於擷取預估等待時間的佇列結構 | 例如：「en」、「es」、「fr」、「de」 "it" "ja" "ko" "pt" 「pt-BR」、「sv」 |
回應
| ID | 欄位名稱 | 類型 | 必要 | 說明 |
|---|---|---|---|---|
| 1 | menu_id | id | 是 | /menus 管理員 API 端點的外鍵 |
| 2 | 等待時間 | INT | 是 | 等待時間 (分鐘) |
| 3 | 具體化路徑 | 字串 | 是 | /menus API 中顯示的具體化路徑 |
範例
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
菜單 ID 10 的預估等待時間為 120 秒 (或兩分鐘)