Apagado de emergencia

Activa o desactiva el cierre de emergencia en una o más colas. Esta API permite que los sistemas externos controlen de forma remota la disponibilidad de la cola en situaciones de emergencia.

Parámetro	Obligatorio	Tipo de datos	Definición
menu_id	verdadero	Arreglo	Es un arreglo de IDs de colas que se actualizarán.
language	verdadero	String	Es el código de idioma ISO 639-1 (por ejemplo, en, es).
emergency_shutdown.enabled	verdadero	Booleano	Habilita (true) o inhabilita (false) el cierre de emergencia.
emergency_shutdown.message.type	falso	String	Es el tipo de mensaje: tts (texto a voz) o audio (URL de audio).
emergency_shutdown.message.content	falso	String	Es el texto de TTS o la URL del archivo de audio. Es obligatorio si se especifica message.type.
emergency_shutdown.in_progress_calls	falso	String	Indica cómo controlar las llamadas en curso: allow_finish, end_and_redirect_to_after_hours, end_and_redirect_to_overcapacity.
emergency_shutdown.queued_calls	falso	String	Indica cómo controlar las llamadas en cola: disconnect, redirect_to_after_hours, redirect_to_overcapacity.

Notas:

• Si no se especifica ningún mensaje cuando se habilita, se usa el mensaje de cierre de emergencia predeterminado global.

• Los parámetros in_progress_calls y queued_calls son opcionales. Si no se especifican, se heredan los parámetros de configuración globales.

• Para usar esta API, debes habilitar la API y la capacidad de cola de emergencia.

Ejemplos

En esta sección, se incluyen ejemplos de código para la API de cierre de emergencia.

Extremo

Método: POST

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

Encabezados

Clave	Valor	Descripción
Content-Type	application/json
Aceptar	application/json

Ejemplo 1: Cierre habilitado

En este ejemplo, se habilita la capacidad de cierre de la cola de emergencia.

Cuerpo de la solicitud

{
    "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"
    }
}

Respuesta

{
    "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"
    }
}

Ejemplo 2: Cierre habilitado, mensaje global predeterminado

En este ejemplo, se habilita la capacidad de cierre de la cola de emergencia y se usa el mensaje global predeterminado.

Cuerpo de la solicitud

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

Respuesta

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

Ejemplo 3: Cierre inhabilitado

En este ejemplo, se inhabilita la capacidad de cierre de la cola de emergencia.

Cuerpo de la solicitud

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

Respuesta

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