Arresto di emergenza

Attiva o disattiva l'arresto d'emergenza su una o più code. Questa API consente ai sistemi esterni di controllare da remoto la disponibilità delle code durante le situazioni di emergenza.

Parametro	Obbligatorio	Tipo di dati	Definizione
menu_id	true	Array	Array di ID delle code da aggiornare.
language	true	Stringa	Codice lingua ISO 639-1 (ad esempio en, es).
emergency_shutdown.enabled	true	Booleano	Attiva (true) o disattiva (false) l'arresto d'emergenza.
emergency_shutdown.message.type	false	Stringa	Tipo di messaggio: tts (text-to-speech) o audio (URL audio).
emergency_shutdown.message.content	false	Stringa	Testo TTS o URL del file audio. Obbligatorio se viene specificato message.type.
emergency_shutdown.in_progress_calls	false	Stringa	Come gestire le chiamate in corso: allow_finish, end_and_redirect_to_after_hours, end_and_redirect_to_overcapacity.
emergency_shutdown.queued_calls	false	Stringa	Come gestire le chiamate in coda: disconnect, redirect_to_after_hours, redirect_to_overcapacity.

Note:

• Se non viene specificato alcun messaggio durante l'attivazione, viene utilizzato il messaggio di arresto d'emergenza predefinito globale.

• I parametri in_progress_calls e queued_calls sono facoltativi. Se non vengono specificati, vengono ereditate le impostazioni globali.

• Per utilizzare questa API, devi abilitare sia l'API sia la funzionalità di coda di emergenza.

Esempi

Questa sezione contiene esempi di codice per l'API di arresto d'emergenza.

Endpoint

Metodo: POST

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

Intestazioni

Chiave	Valore	Descrizione
Content-Type	application/json
Accetta	application/json

Esempio 1: arresto attivato

Questo esempio attiva la funzionalità di arresto della coda di emergenza.

Corpo della richiesta

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

Risposta

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

Esempio 2: arresto attivato, messaggio globale predefinito

Questo esempio attiva la funzionalità di arresto della coda di emergenza e utilizza il messaggio globale predefinito.

Corpo della richiesta

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

Risposta

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

Esempio 3: arresto disattivato

Questo esempio disattiva la funzionalità di arresto della coda di emergenza.

Corpo della richiesta

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

Risposta

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