等待时间端点

Contact Center AI 平台 (CCAI Platform) 提供 Wait time 端点,用于获取不同渠道类型队列的当前等待时间。

等待时间

参数 必需 数据类型 定义
lang TRUE 字符串 队列的语言代码。(例如“en”)
menu_id FALSE 整数 响应将过滤相应菜单子树中的所有菜单,包括相应菜单。
menu_type FALSE 字符串 返回特定类型的菜单。可能的值:ivr_menu、mobile_menu、web_menu)。
channel_type FALSE 字符串 返回特定频道的菜单。可能的值:voice_call、chat)。
等待 [从] 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
等待 [从] 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
等待 [从] 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