대기열 엔드포인트

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

대기열 상태

예상 대기 시간, 상담사 가용성, 콜백 슬롯 용량, 영업시간, 휴일을 포함한 리프 대기열의 실시간 데이터를 제공합니다. 이를 사용하여 음성 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 정수 콜백 슬롯 기간을 반환할 총 미래 기간 길이(시간)입니다. 1~24 사이여야 합니다. 생략하면 계정에 용량 기반 예약이 사용 설정되지 않은 경우 기본 4시간 기간이 사용됩니다. (선택사항)
callback_start_from 문자열 콜백 시간대 검색 기간의 시작 시간입니다. 대기열 또는 회사 시간대의 ISO 8601 datetime 형식입니다. 생략하면 기본값은 현재 시간 (서버 시간이 대기열 또는 회사 시간대로 변환됨)입니다. 과거 시간으로 설정할 수는 없습니다. (선택사항)

응답 예시

{
    "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,
                    "available_slots": 1
                },
                {
                    "date": "20260225",
                    "start_time": "17:45",
                    "end_time": "18:00",
                    "scheduled_calls": 0,
                    "max_slots": 1,
                    "available_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
}