긴급 종료

하나 이상의 대기열에서 긴급 종료를 사용 설정하거나 사용 중지합니다. 이 API를 사용하면 외부 시스템에서 긴급 상황 시 대기열 가용성을 원격으로 제어할 수 있습니다.

매개변수 필수 데이터 유형 정의
menu_id true 배열 업데이트할 대기열 ID의 배열입니다.
language true 문자열 ISO 639-1 언어 코드 (예: en, es)
emergency_shutdown.enabled true 불리언 긴급 종료를 사용 설정 (true) 또는 사용 중지 (false)합니다.
emergency_shutdown.message.type 거짓 문자열 메시지 유형: tts (텍스트 음성 변환) 또는 audio (오디오 URL)
emergency_shutdown.message.content 거짓 문자열 TTS 텍스트 또는 오디오 파일 URL입니다. message.type이 지정된 경우 필수입니다.
emergency_shutdown.in_progress_calls 거짓 문자열 진행 중인 통화 처리 방법: allow_finish, end_and_redirect_to_after_hours, end_and_redirect_to_overcapacity
emergency_shutdown.queued_calls 거짓 문자열 대기열에 추가된 통화를 처리하는 방법: disconnect, redirect_to_after_hours, redirect_to_overcapacity

참고:

  • 사용 설정 시 메시지를 지정하지 않으면 전역 기본 긴급 종료 메시지가 사용됩니다.

  • in_progress_calls 및 queued_calls 매개변수는 선택사항입니다. 지정되지 않은 경우 전역 설정이 상속됩니다.

  • 이 API를 사용하려면 API와 긴급 대기열 기능을 모두 사용 설정해야 합니다.

예시

이 섹션에는 긴급 종료 API의 코드 예가 포함되어 있습니다.

엔드포인트

메서드: POST

URL: https://{subdomain}.{domain}/apps/api/v1/menus/shutdown

헤더

키 값 설명
Content-Type application/json
수락 application/json

예 1: 종료 사용 설정

이 예시에서는 긴급 큐 종료 기능을 사용 설정합니다.

요청 본문

{
    "menu_id": [
        123,
        456
    ],
    "language": "en",
    "emergency_shutdown": {
        "enabled": true,
        "message": {
            "type": "tts",
            "content": "We are currently experiencing an emergency. Please call back later."
        },
        "in_progress_calls": "allow_finish",
        "queued_calls": "disconnect"
    }
}

응답

{
    "menu_id": [
        123,
        456
    ],
    "language": "en",
    "emergency_shutdown": {
        "enabled": true,
        "message": {
            "type": "tts",
            "content": "We are currently experiencing an emergency. Please call back later."
        },
        "in_progress_calls": "allow_finish",
        "queued_calls": "disconnect"
    }
}

예 2: 종료가 사용 설정되고 기본 전역 메시지가 표시됨

이 예시에서는 긴급 큐 종료 기능을 사용 설정하고 기본 전역 메시지를 사용합니다.

요청 본문

{
    "menu_id": [
        123
    ],
    "language": "en",
    "emergency_shutdown": {
        "enabled": true
    }
}

응답

{
    "success": true,
    "affected_queues": [
        123
    ],
    "emergency_shutdown": {
        "enabled": true,
        "message_source": "global_default",
        "in_progress_calls": null,
        "queued_calls": null
    }
}

예 3: 종료 사용 중지

이 예시에서는 긴급 대기열 종료 기능을 사용 중지합니다.

요청 본문

{
    "menu_id": [
        123
    ],
    "language": "en",
    "emergency_shutdown": {
        "enabled": false
    }
}

응답

{
    "success": true,
    "affected_queues": [
        123
    ],
    "emergency_shutdown": {
        "enabled": false,
        "message_source": null,
        "in_progress_calls": null,
        "queued_calls": null
    }
}