כיבוי חירום

הפעלה או השבתה של כיבוי חירום בתור אחד או יותר. ה-API הזה מאפשר למערכות חיצוניות לשלוט מרחוק בזמינות של תורים במצבי חירום.

פרמטר	חובה	סוג הנתונים	הגדרה
menu_id	TRUE	מערך	מערך של מזהי תורים לעדכון.
language	TRUE	String	קוד שפה ISO 639-1 (לדוגמה, en, ‏ es).
emergency_shutdown.enabled	TRUE	בוליאני	מפעילים (true) או משביתים (false) את כיבוי החירום.
emergency_shutdown.message.type	FALSE	String	סוג ההודעה: tts (המרת טקסט לדיבור) או audio (כתובת URL של אודיו).
emergency_shutdown.message.content	FALSE	String	כתובת URL של קובץ אודיו או טקסט ל-TTS. חובה אם מציינים את message.type.
emergency_shutdown.in_progress_calls	FALSE	String	איך לטפל בשיחות פעילות: allow_finish, end_and_redirect_to_after_hours, end_and_redirect_to_overcapacity.
emergency_shutdown.queued_calls	FALSE	String	איך לטפל בשיחות בהמתנה: disconnect, redirect_to_after_hours, redirect_to_overcapacity.

הערות:

• אם לא מציינים הודעה כשמפעילים את התכונה, המערכת משתמשת בהודעת ברירת המחדל הגלובלית על כיבוי חירום.

• הפרמטרים in_progress_calls ו-queued_calls הם אופציונליים. אם לא מציינים אותם, המערכת מקבלת בירושה את ההגדרות הגלובליות.

• כדי להשתמש ב-API הזה, צריך להפעיל גם את ה-API וגם את היכולת של תור הפניות הדחופות.

דוגמאות

בקטע הזה יש דוגמאות קוד ל-API של כיבוי במקרה חירום.

נקודת קצה (endpoint)

שיטה: POST

כתובת URL: https://{subdomain}.{domain}/apps/api/v1/menus/shutdown

כותרות

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

דוגמה 1: השבתה מופעלת

בדוגמה הזו מופעלת היכולת להשבית את תור ההמתנה למקרי חירום.

גוף הבקשה

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

תשובה

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

דוגמה 2: השבתה מופעלת, הודעה גלובלית שמוגדרת כברירת מחדל

בדוגמה הזו מופעלת היכולת להשבית את תור החירום, ונעשה שימוש בהודעה הגלובלית שמוגדרת כברירת מחדל.

גוף הבקשה

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

תשובה

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

דוגמה 3: השבתת המחשב מושבתת

בדוגמה הזו, היכולת להשבית את תור החירום מושבתת.

גוף הבקשה

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

תשובה

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