Contact Center AI 平台 (CCAI 平台) 提供「等待時間」端點，可取得不同管道類型佇列的目前等待時間。
等待時間
| 參數 | 必填 | 資料類型 | 定義 |
|---|---|---|---|
| lang | TRUE | 字串 | 佇列的語言代碼。(例如「en」) |
| menu_id | FALSE | 整數 | 回應會篩選該菜單子樹中的所有菜單，包括該菜單。 |
| menu_type | FALSE | 字串 | 傳回特定類型的選單。可能的值：ivr_menu、mobile_menu、web_menu。 |
| channel_type | FALSE | 字串 | 傳回特定頻道的菜單。可能的值：voice_call、chat)。 |
| wait[from] | FALSE | 整數 | 如果記錄的等待時間大於該值，就會傳回記錄。 |
| wait[to] | FALSE | 整數 | 如果記錄的等待時間小於該值，就會傳回記錄。 |
端點：
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/apps/api/v1/wait_times
標題：
| 鍵 | 值 | 說明 |
|---|---|---|
| Content-Type | application/json |
要求和回應範例
下列各節提供端點的要求範例。
行動佇列的等待時間
這個範例說明如何擷取行動裝置佇列的等待時間。
要求
標題：
| 鍵 | 值 | 說明 |
|---|---|---|
| Content-Type | application/json |
查詢：
| 鍵 | 值 | 說明 |
|---|---|---|
| lang | en | |
| menu_type | mobile_menu |
內文：無
回覆：行動裝置佇列的等待時間
[
{
"menu_id": 29,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
狀態碼：200
wait[from] 到 wait[to] 之間的等待時間
這個範例說明如何擷取等待時間介於「等待時間從」和「等待時間到」值之間的通話。
要求
標題：
| 鍵 | 值 | 說明 |
|---|---|---|
| Content-Type | application/json |
查詢：
| 鍵 | 值 | 說明 |
|---|---|---|
| lang | en | |
| wait[from] | 5 | |
| wait[to] | 15 |
內文：無
回應：wait[from] 到 wait[to] 之間的等待時間
[
{
"menu_id": 3,
"menu_type": "web_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Web App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 29,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 44,
"menu_type": "web_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Mobile App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
狀態碼：200
行動佇列語音通話的等待時間超過 5 秒
這個範例示範如何擷取等待時間超過 5 秒的行動裝置語音通話。
要求
標題：
| 鍵 | 值 | 說明 |
|---|---|---|
| Content-Type | application/json |
查詢：
| 鍵 | 值 | 說明 |
|---|---|---|
| lang | en | |
| menu_type | mobile_menu | |
| channel_type | voice_call | |
| wait[from] | 5 |
內文：無
回應：行動佇列的語音通話等待時間超過 5 秒
[
{
"menu_id": 29,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
狀態碼：200
特定選單的等待時間
這個範例說明如何擷取特定菜單 ID 的等待時間。
要求
標題：
| 鍵 | 值 | 說明 |
|---|---|---|
| Content-Type | application/json |
查詢：
| 鍵 | 值 | 說明 |
|---|---|---|
| lang | en | |
| menu_id | 9 |
內文：無
回覆：特定菜單的等待時間
[
{
"menu_id": 9,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Death Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
狀態碼：200
所有語音通話的等待時間
這個範例示範如何擷取所有目前語音通話的等待時間。
要求
標題：
| 鍵 | 值 | 說明 |
|---|---|---|
| Content-Type | application/json |
查詢：
| 鍵 | 值 | 說明 |
|---|---|---|
| lang | en | |
| channel_type | voice_call |
內文：無
回覆：所有語音通話的等待時間
[
{
"menu_id": 3,
"menu_type": "web_menu",
"voice_call": 10,
"materialized_path": "Web App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 9,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Death Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 29,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 41,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Lock Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 44,
"menu_type": "web_menu",
"voice_call": 10,
"materialized_path": "Mobile App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
狀態碼：200
英文服務隊伍的等待時間
這個範例示範如何擷取語言為英文的所有佇列等待時間。
要求
標題：
| 鍵 | 值 | 說明 |
|---|---|---|
| Content-Type | application/json |
查詢：
| 鍵 | 值 | 說明 |
|---|---|---|
| lang | en |
內文：無
回覆：英文佇列的等待時間
[
{
"menu_id": 3,
"menu_type": "web_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Web App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 9,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Death Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 29,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 41,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Lock Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 44,
"menu_type": "web_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Mobile App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
狀態碼：200