此 API 端点会返回每个队列的计算得出的预计等待时间 (EWT)。
这可用于在 Contact Center AI 平台 (CCAI 平台) SDK 之外的网页或移动应用上显示自定义支持渠道 EWT,或用于自定义通知或触发器。
示例请求
网址: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 | 等待 [从] | 整数 | 否 | 如果记录的等待时间大于指定值,则返回相应记录 | 验证:仅限正整数 | |
| 5 | wait[to] | 整数 | 否 | 如果记录的等待时间小于指定值,则返回相应记录 | 验证:仅限正整数 | |
| 6 | lang | 枚举 | 是 | 用于检索 ewt 的队列结构 | 例如:“en”“es”“fr”“de” “it”“ja”“ko”“pt” “pt-BR”“sv” |
响应
| ID | 字段名称 | 类型 | 必需 | 说明 |
|---|---|---|---|---|
| 1 | menu_id | id | 是 | 指向 /menus 管理器 API 端点的外键 |
| 2 | wait | 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 秒(或 2 分钟)