Notabschaltung

Aktivieren oder deaktivieren Sie die Notabschaltung für eine oder mehrere Warteschlangen. Mit dieser API können externe Systeme die Verfügbarkeit von Warteschlangen in Notsituationen per Fernzugriff steuern.

Parameter	Erforderlich	Datentyp	Definition
menu_id	wahr	Array	Array mit den IDs der Warteschlangen, die aktualisiert werden sollen.
language	wahr	String	ISO 639-1-Sprachcode (z. B. en, es).
emergency_shutdown.enabled	wahr	Boolesch	Aktivieren (true) oder deaktivieren (false) Sie die Notabschaltung.
emergency_shutdown.message.type	falsch	String	Nachrichtentyp: tts (Text-to-Speech) oder audio (Audio-URL).
emergency_shutdown.message.content	falsch	String	TTS-Text oder URL der Audiodatei. Erforderlich, wenn message.type angegeben ist.
emergency_shutdown.in_progress_calls	falsch	String	So werden laufende Anrufe behandelt: allow_finish, end_and_redirect_to_after_hours, end_and_redirect_to_overcapacity.
emergency_shutdown.queued_calls	falsch	String	So gehen Sie mit Anrufen in der Warteschleife um: disconnect, redirect_to_after_hours, redirect_to_overcapacity.

Hinweise:

• Wenn beim Aktivieren keine Nachricht angegeben wird, wird die globale Standardnachricht für das Herunterfahren im Notfall verwendet.

• Die Parameter in_progress_calls und queued_calls sind optional. Wenn sie nicht angegeben sind, werden globale Einstellungen übernommen.

• Um diese API verwenden zu können, müssen Sie sowohl die API als auch die Funktion für die Notfallwarteschlange aktivieren.

Beispiele

Dieser Abschnitt enthält Codebeispiele für die API zum Herunterfahren im Notfall.

Endpunkt

Methode: POST

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

Header

Schlüssel	Wert	Beschreibung
Content-Type	application/json
Akzeptieren	application/json

Beispiel 1: Herunterfahren aktiviert

In diesem Beispiel wird die Funktion zum Schließen der Notfallwarteschlange aktiviert.

Anfragetext

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

Antwort

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

Beispiel 2: Herunterfahren aktiviert, globale Standardnachricht

In diesem Beispiel wird die Funktion zum Schließen der Notfallwarteschlange aktiviert und die globale Standardnachricht verwendet.

Anfragetext

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

Antwort

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

Beispiel 3: Herunterfahren deaktiviert

In diesem Beispiel wird die Möglichkeit zum Herunterfahren der Notfallwarteschlange deaktiviert.

Anfragetext

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

Antwort

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