Penonaktifan darurat

Mengaktifkan atau menonaktifkan penghentian darurat pada satu atau beberapa antrean. API ini memungkinkan sistem eksternal mengontrol ketersediaan antrean dari jarak jauh selama situasi darurat.

Parameter	Wajib	Jenis Data	Definisi
menu_id	true	Array	Array ID antrean yang akan diperbarui.
language	true	String	Kode bahasa ISO 639-1 (misalnya, en, es).
emergency_shutdown.enabled	true	Boolean	Mengaktifkan (true) atau menonaktifkan (false) penghentian darurat.
emergency_shutdown.message.type	false	String	Jenis pesan: tts (text-to-speech) atau audio (URL audio).
emergency_shutdown.message.content	false	String	Teks TTS atau URL file audio. Wajib jika message.type ditentukan.
emergency_shutdown.in_progress_calls	false	String	Cara menangani panggilan yang sedang berlangsung: allow_finish, end_and_redirect_to_after_hours, end_and_redirect_to_overcapacity.
emergency_shutdown.queued_calls	false	String	Cara menangani panggilan yang diantrekan: disconnect, redirect_to_after_hours, redirect_to_overcapacity.

Catatan:

• Jika tidak ada pesan yang ditentukan saat mengaktifkan, pesan penghentian darurat default global akan digunakan.

• Parameter in_progress_calls dan queued_calls bersifat opsional. Jika tidak ditentukan, setelan global akan diwarisi.

• Untuk menggunakan API ini, Anda harus mengaktifkan API dan kemampuan antrean darurat.

Contoh

Bagian ini berisi contoh kode untuk API penghentian darurat.

Endpoint

Metode: POST

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

Header

Kunci	Nilai	Deskripsi
Content-Type	application/json
Accept	application/json

Contoh 1: penghentian diaktifkan

Contoh ini mengaktifkan kemampuan penghentian antrean darurat.

Isi permintaan

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

Respons

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

Contoh 2: penghentian diaktifkan, pesan global default

Contoh ini mengaktifkan kemampuan penghentian antrean darurat dan menggunakan pesan global default.

Isi permintaan

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

Respons

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

Contoh 3: penghentian dinonaktifkan

Contoh ini menonaktifkan kemampuan penghentian antrean darurat.

Isi permintaan

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

Respons

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