队列端点

队列状态端点会返回队列信息，以确定是否要转移来电。

队列状态

为叶队列提供实时数据，包括预计等待时间、客服人员空闲情况、回电预约容量、服务时间以及节假日。使用此功能可让语音 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
}