Arrêt d'urgence

Activez ou désactivez l'arrêt d'urgence pour une ou plusieurs files d'attente. Cette API permet aux systèmes externes de contrôler à distance la disponibilité des files d'attente en cas d'urgence.

Paramètre	Obligatoire	Type de données	Définition
menu_id	vrai	Tableau	Tableau des ID de files d'attente à mettre à jour.
language	vrai	Chaîne	Code de langue ISO 639-1 (par exemple, en, es).
emergency_shutdown.enabled	vrai	Booléen	Activez (true) ou désactivez (false) l'arrêt d'urgence.
emergency_shutdown.message.type	faux	Chaîne	Type de message : tts (synthèse vocale) ou audio (URL audio).
emergency_shutdown.message.content	faux	Chaîne	URL du fichier audio ou du texte TTS. Obligatoire si message.type est spécifié.
emergency_shutdown.in_progress_calls	faux	Chaîne	Gérer les appels en cours : allow_finish, end_and_redirect_to_after_hours, end_and_redirect_to_overcapacity.
emergency_shutdown.queued_calls	faux	Chaîne	Gérer les appels mis en file d'attente : disconnect, redirect_to_after_hours, redirect_to_overcapacity.

Remarques :

• Si aucun message n'est spécifié lors de l'activation, le message d'arrêt d'urgence global par défaut est utilisé.

• Les paramètres in_progress_calls et queued_calls sont facultatifs. Si elles ne sont pas spécifiées, les paramètres globaux sont hérités.

• Pour utiliser cette API, vous devez activer à la fois l'API et la fonctionnalité de file d'attente d'urgence.

Exemples

Cette section contient des exemples de code pour l'API d'arrêt d'urgence.

Point de terminaison

Méthode : POST

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

Headers

Clé	Valeur	Description
Content-Type	application/json
Accepter	application/json

Exemple 1 : Arrêt activé

Cet exemple active la fonctionnalité d'arrêt de la file d'attente d'urgence.

Corps de la requête

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

Réponse

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

Exemple 2 : Arrêt activé, message global par défaut

Cet exemple active la fonctionnalité d'arrêt de la file d'attente d'urgence et utilise le message global par défaut.

Corps de la requête

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

Réponse

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

Exemple 3 : Arrêt désactivé

Cet exemple désactive la fonctionnalité d'arrêt de la file d'attente d'urgence.

Corps de la requête

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

Réponse

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