緊急關機

開啟或關閉一或多個佇列的緊急關機功能。在緊急情況下，外部系統可透過這個 API 遠端控管佇列可用性。

參數	必填	資料類型	定義
menu_id	true	陣列	要更新的佇列 ID 陣列。
language	true	字串	ISO 639-1 語言代碼 (例如 en、es)。
emergency_shutdown.enabled	true	布林值	啟用 (true) 或停用 (false) 緊急關機功能。
emergency_shutdown.message.type	false	字串	訊息類型：tts (文字轉語音) 或 audio (音訊網址)。
emergency_shutdown.message.content	false	字串	TTS 文字或音訊檔案網址。如果指定 message.type，則為必要欄位。
emergency_shutdown.in_progress_calls	false	字串	如何處理進行中的通話：allow_finish、end_and_redirect_to_after_hours、end_and_redirect_to_overcapacity。
emergency_shutdown.queued_calls	false	字串	如何處理已加入佇列的通話：disconnect、redirect_to_after_hours、redirect_to_overcapacity。

注意：

• 啟用時如未指定訊息，系統會使用全域預設緊急關機訊息。

• in_progress_calls 和 queued_calls 參數為選用參數。如未指定，系統會沿用全域設定。

• 如要使用這項 API，您必須同時啟用 API 和緊急佇列功能。

範例

本節包含緊急關機 API 的程式碼範例。

端點

方法：POST

網址：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
    }
}