緊急シャットダウン

1 つ以上のキューで緊急シャットダウンをオンまたはオフにします。この API を使用すると、外部システムは緊急時にキューの可用性をリモートで制御できます。

パラメータ 必須 データ型 定義
menu_id true 配列 更新するキュー ID の配列。
language true 文字列 ISO 639-1 言語コード（en、es など）。
emergency_shutdown.enabled true ブール値 緊急シャットダウンを有効（true）または無効（false）にします。
emergency_shutdown.message.type false 文字列 メッセージ タイプ: tts（テキスト読み上げ）または audio（音声 URL）。
emergency_shutdown.message.content false 文字列 TTS テキストまたは音声ファイルの URL。message.type が指定されている場合は必須。
emergency_shutdown.in_progress_calls false 文字列 処理中の通話の処理方法: allow_finish、end_and_redirect_to_after_hours、end_and_redirect_to_overcapacity。
emergency_shutdown.queued_calls false 文字列 キューに登録された通話の処理方法: disconnect、redirect_to_after_hours、redirect_to_overcapacity。

注:

  • 有効にする際にメッセージが指定されていない場合は、グローバル デフォルトの緊急シャットダウン メッセージが使用されます。

  • in_progress_calls パラメータと queued_calls パラメータは省略可能です。指定しない場合は、グローバル設定が継承されます。

  • この API を使用するには、API と緊急キュー機能の両方を有効にする必要があります。

例

このセクションでは、緊急シャットダウン API のコード例を示します。

エンドポイント

メソッド: POST

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

ヘッダー

キー 値 説明
Content-Type 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
    }
}