대기열 엔드포인트

대기열 상태 엔드포인트는 통화를 전환할지 여부를 결정하기 위해 대기열 정보를 반환합니다.

큐 상태

예상 대기 시간, 상담사 응대 가능 여부, 콜백 슬롯 용량, 운영 시간, 공휴일 등 리프 대기열에 대한 실시간 데이터를 제공합니다. 이를 사용하여 음성 AI 시스템이 통화를 실제 상담사에게 에스컬레이션할지 또는 발신자에게 예약된 콜백 창을 제공할지 동적으로 결정하도록 합니다. 자세한 내용은 대기열 상태 엔드포인트를 참고하세요.

요청 예시

메서드: GET

URL: 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 datetime 형식으로 된 콜백 시간대 검색 창의 시작입니다. 생략하면 현재 시간 (서버 시간을 대기열 또는 회사 시간대로 변환)이 기본값입니다. 과거가 아니어야 하며 최대 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

URL: 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
}