紧急关停

在一个或多个队列中开启或关闭紧急关停。此 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
    }
}