Alerts インターフェース

    Alertsインターフェースは、タイマー、アラーム、リマインダーのセット、管理、キャンセルを行うのに使用するディレクティブとイベントを提供します。クライアントには、インターネット接続が失われた場合または製品に内蔵された時計がNTPと同期されない場合のために、タイマー、アラーム、リマインダーの管理に必要なロジックを実装する必要があります。実装に関するその他の詳細は、Alertsの概要および対話モデルを参照してください。

    バージョンによる変更点

    • SetAlertディレクティブのペイロードは、名前付きのタイマーとリマインダーをサポートするよう更新されました。この変更には下位互換性があります。

    状態ダイアグラム

    以下のダイアグラムは、Alertsコンポーネントによって制御される状態の変化を表しています。ボックスはAlertsの状態、コネクターは遷移を示します。

    Alertsでは、以下の状態がサポートされます。

    IDLE:以前にセットされたアラートが鳴動するまで、Alertsコンポーネントはidle状態である必要があります。また、アラートが停止/終了した際にも、idle状態に戻る必要があります。これは、ユーザー音声、物理ボタンの押下、GUIアフォーダンスの結果として発生する可能性があります。

    FOREGROUND ALERT:クライアント上のアラートがすでにセットされているとした場合、Alertsは、アラートが開始され、AlertStartedイベントがAVSに送信されたら、idle状態からalert foreground状態に遷移する必要があります。

    これは、Alertsチャンネルがフォアグラウンドの場合、つまりDialogチャンネルが非アクティブの場合にのみ該当します。チャンネルおよびチャンネルの優先順位付けの詳細については、対話モデルを参照してください。

    アラートが音声、ボタン押下、GUIアフォーダンスにより停止されたら、Alertsコンポーネントはalert foreground状態からidle状態に遷移する必要があります。

    アラートの鳴動中にDialogチャンネルがアクティブになると、Dialogチャンネルがアクティブな間、Alertsコンポーネントはforeground alert状態からbackground alert状態に遷移する必要があります。Dialogチャンネルが非アクティブになったら、アラートが停止/終了するまでforeground alert状態に戻る必要があります。

    BACKGROUND ALERT:Alertsコンポーネントがbackground alert状態になるのは、Dialogチャンネルがアクティブになったときのみです。チャンネルおよびチャンネルの優先順位付けの詳細については、対話モデルを参照してください。

    Alertsの状態ダイアグラム
    クリックして拡大

    機能API

    Alertsインターフェースのバージョン1.1を使用するには、機能APIの呼び出し内で宣言する必要があります。詳細については、機能APIを参照してください。

    オブジェクトのサンプル

    {
        "type": "AlexaInterface",
        "interface": "Alerts",
        "version": "1.1",
        "configurations": {
            "maximumAlerts": {
                "overall": {{INTEGER}},
                "alarms": {{INTEGER}},
                "timers": {{INTEGER}}
            }
        }
    }
    

    設定のパラメーター

    パラメーター 説明
    maximumAlerts 実装したアラートの設定情報を含むオブジェクトです。 オブジェクト
    maximumAlerts.overall 所定の時間に製品が格納できるアラートの組み合わせ(タイマーとアラーム)の最大数を表します。 整数
    maximumAlerts.alarms 所定の時間に製品が格納できるアラームの最大数を表します。 整数
    maximumAlerts.timers 所定の時間に製品が格納できるタイマーの最大数を表します。 整数

    Alertsのコンテキスト

    Alexaは、コンテキストが必要な各イベントで、ローカルに保存されたアラートのステータスがクライアントからレポートされることを想定しています。Alertsは、2つのリストに分類されます。 allAlertsactiveAlertsです。 allAlerts は、ローカルに保存されたすべてのアラートのリストです。 activeAlerts は、現在フォーカスのあるアラート、またはエンドユーザーに対して鳴動しているアラートのリストです。

    コンテキストのレポートの詳細については、コンテキストの概要を参照してください。

    サンプルメッセージ

    {
        "header": {
            "namespace": "Alerts",
            "name": "AlertsState"
        },
        "payload": {
            "allAlerts": [
                {
                    "token": "{{STRING}}",
                    "type": "{{STRING}}",
                    "scheduledTime": "{{STRING}}"
                }
            ],
            "activeAlerts": [
                {
                    "token": "{{STRING}}",
                    "type": "{{STRING}}",
                    "scheduledTime": "{{STRING}}"
                }
            ]
        }
    }
    

    ペイロードのパラメーター

    パラメーター 説明
    allAlerts allAlertsのキー/値ペア。 オブジェクト
    allAlerts.token アラートがセットされたときにAlexaによって返されるアラートトークンです。 文字列
    allAlerts.type アラートの種類を示します。
    有効な値:TIMER、ALARM、REMINDERです。
    文字列
    allAlerts.scheduledTime ISO 8601形式のアラートの設定時刻。 文字列
    activeAlerts activeAlertsのキー/値ペア。 オブジェクト
    activeAlerts.token 現在発生中のアラートのトークンです。 文字列
    activeAlerts.type アラートの種類を示します。
    有効な値:TIMERまたはALARM
    文字列
    activeAlerts.scheduledTime ISO 8601形式のアラートの設定時刻。 文字列

    SetAlertディレクティブ

    このディレクティブはクライアントに、特定の時間または時刻のタイマー、アラーム、リマインダーをセットするよう指示します。クライアントは、アラートをセットする音声リクエストの結果として、またはAmazon Alexaアプリを使用して以前にセットされていたアラートが再度有効化されたときに、SetAlertディレクティブを受信することがあります。

    ペイロードにloopCountがない場合、アラートは1時間、またはユーザーによって停止される(音声リクエストまたは物理的なボタンなどの操作によって)まで鳴動する必要があります。

    クラウドで提供されたassetsは、ローカルに保存されたオーディオファイルより優先されます。assetsが提供された場合、assetPlayOrderリストに指定された順序でユーザーに対して再生される必要があります。提供されなかった場合は、Amazonが提供するアラートのオーディオファイルを使用します。

    サンプルメッセージ

    {
        "directive": {
            "header": {
                "namespace": "Alerts",
                "name": "SetAlert",
                "messageId": "{{STRING}}",
                "dialogRequestId": "{{STRING}}"
            },
            "payload": {
                "token": "{{STRING}}",
                "type": "{{STRING}}",
                "scheduledTime": "{{STRING}}",
                "assets": [
                    {
                        "assetId": "{{STRING}}",
                        "url": "{{STRING}}"
                    },
                    {
                        "assetId": "{{STRING}}",
                        "url": "{{STRING}}"
                    },
                ],
                "assetPlayOrder": [ {{LIST}} ],
                "backgroundAlertAsset": "{{STRING}}",
                "loopCount": {{LONG}},
                "loopPauseInMilliSeconds": {{LONG}}
            }
        }
    }
    

    ヘッダーのパラメーター

    パラメーター 説明
    messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列
    dialogRequestId 特定のRecognizeイベントの応答として送信されるディレクティブの関連付けに使用する一意のID 文字列

    ペイロードのパラメーター

    パラメーター 説明
    token アラートを一意に識別する不透明なトークンです。 文字列
    type アラートの種類を示します。認識されない値がクライアントに送信された場合、デフォルトのALARMに設定する必要があります。
    有効な値:TIMERALARMREMINDERです。
    文字列
    scheduledTime ISO 8601形式のアラートの設定時刻。 文字列
    assets ユーザーに再生するオーディオアセットを含むリスト。 リスト
    assets[i].assetId オーディオアセットの一意の識別子。 文字列
    assets[i].url クラウド内のアセットの場所を識別します。アセットはクライアントによってダウンロードされキャッシュされることがあります。提供されるURLは、scheduledTimeの後60分間有効です。 文字列
    assetPlayOrder オーディオアセットを再生する必要のある順序。assetIdで構成されるリスト。

    : i) assetIdがリスト内に複数回出現する場合があります。この場合、すべてのassetIdを再生する必要があります。ii) クライアントがアセットのダウンロードとキャッシュに失敗した場合、デバイスはAmazonにより提供されるオーディオファイルを使用する必要があります。
    リスト
    backgroundAlertAsset 存在する場合、backgroundAlertAssetの値はassetsリストのassetIdと一致します。ペイロードにbackgroundAlertAssetが含まれない場合は、デフォルトでAVS用のAlexaサウンドライブラリにあるAmazon提供のサウンドが使用されます。開発者コンソール「Alexa Voice Service」>「Resources」セクションからダウンロード可能です。 文字列
    loopCount アセットの各シーケンスを再生する必要のある回数。例:値が2の場合、クライアントはassetPlayOrderを通しで2回ループする必要があります。

    :ペイロードにloopCountがない場合、assetsを1時間、またはアラートがユーザーによって停止されるまでの間、ループする必要があります。
    long
    loopPauseInMilliSeconds 各アセットループ間の一時停止時間。例:loopPauseInMilliSeconds300で、loopCount3の場合、クライアントは各アセットループ間に300ミリ秒一時停止する必要があります。

    :この値が指定されない場合、または0に設定されている場合、アセットループ間に一時停止してはなりません。
    long

    SetAlertSucceededイベント

    クライアントがアラートを正常にセットし、SetAlertディレクティブを受信した後、SetAlertSucceededイベントをAVSに送信する必要があります。

    サンプルメッセージ

    {
        "event": {
            "header": {
                "namespace": "Alerts",
                "name": "SetAlertSucceeded",
                "messageId": "{{STRING}}"
            },
            "payload": {
                "token": "{{STRING}}"
            }
        }
    }
    

    ヘッダーのパラメーター

    パラメーター 説明
    messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

    ペイロードのパラメーター

    パラメーター 説明
    token SetAlertディレクティブで提供される不透明なトークンです。 文字列

    SetAlertFailedイベント

    クライアントがアラートのセットに失敗した場合は、SetAlertディレクティブを受信した後、SetAlertFailedイベントをAVSに送信する必要があります。

    サンプルメッセージ

    {
        "event": {
            "header": {
                "namespace": "Alerts",
                "name": "SetAlertFailed",
                "messageId": "{{STRING}}"
            },
            "payload": {
                "token": "{{STRING}}"
            }
        }
    }
    

    ヘッダーのパラメーター

    パラメーター 説明
    messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

    ペイロードのパラメーター

    パラメーター 説明
    token SetAlertディレクティブで提供される不透明なトークンです。 文字列

    DeleteAlertディレクティブ

    このディレクティブは、既存のアラートを削除するようAVSからクライアントに送信されます。クライアントは、タイマー、アラーム、またはリマインダーをキャンセル/削除する音声リクエストの結果として、またはAmazon Alexaアプリを使用して以前にセットされていたアラートが削除されたときに、DeleteAlertディレクティブを受信することがあります。

    サンプルメッセージ

    {
        "directive": {
            "header": {
                "namespace": "Alerts",
                "name": "DeleteAlert",
                "messageId": "{{STRING}}",
                "dialogRequestId": "{{STRING}}"
            },
            "payload": {
                "token": "{{STRING}}"
            }
        }
    }
    

    ヘッダーのパラメーター

    パラメーター 説明
    messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列
    dialogRequestId 特定のRecognizeイベントの応答として送信されるディレクティブの関連付けに使用する一意のID 文字列

    ペイロードのパラメーター

    パラメーター 説明
    token アラートを一意に識別する不透明なトークンです。 文字列

    DeleteAlertSucceededイベント

    クライアントが既存のアラートを正常に削除またはキャンセルすると、DeleteAlertディレクティブを受信した後、DeleteAlertSucceededイベントをAVSに送信する必要があります。

    サンプルメッセージ

    {
        "event": {
            "header": {
                "namespace": "Alerts",
                "name": "DeleteAlertSucceeded",
                "messageId": "{{STRING}}"
            },
            "payload": {
                "token": "{{STRING}}"
            }
        }
    }
    

    ヘッダーのパラメーター

    パラメーター 説明
    messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

    ペイロードのパラメーター

    パラメーター 説明
    token DeleteAlertディレクティブで提供される不透明なトークンです。 文字列

    DeleteAlertFailedイベント

    クライアントが既存のアラートの削除またはキャンセルに失敗した場合、DeleteAlertディレクティブを受信した後、DeleteAlertFailedイベントをAVSに送信する必要があります。

    サンプルメッセージ

    {
        "event": {
            "header": {
                "namespace": "Alerts",
                "name": "DeleteAlertFailed",
                "messageId": "{{STRING}}"
            },
            "payload": {
                "token": "{{STRING}}"
            }
        }
    }
    

    ヘッダーのパラメーター

    パラメーター 説明
    messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

    ペイロードのパラメーター

    パラメーター 説明
    token DeleteAlertディレクティブで提供される不透明なトークンです。 文字列

    AlertStartedイベント

    アラートが設定された時刻にトリガーされると、AlertStartedイベントをAVSに対して送信する必要があります。

    サンプルメッセージ

    {
        "event": {
            "header": {
                "namespace": "Alerts",
                "name": "AlertStarted",
                "messageId": "{{STRING}}"
            },
            "payload": {
                "token": "{{STRING}}"
            }
        }
    }
    

    ヘッダーのパラメーター

    パラメーター 説明
    messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

    ペイロードのパラメーター

    パラメーター 説明
    token SetAlertディレクティブで提供される不透明なトークンです。 文字列

    AlertStoppedイベント

    AlertStoppedイベントは、アクティブなアラートが停止した場合にAVSに送信される必要があります。アラートは以下の場合に停止します。

    1. DeleteAlertディレクティブを受信した場合。AlertStoppedイベントの送信後、クライアントは、DeleteAlertSucceededイベント、DeleteAlertFailedイベントのどちらでアラートが正常に削除されたかどうかをAVSに知らせる必要があります。この対話については、Alertsの概要で説明されています。
    2. アラートの停止には、物理コントロール(ハードウェアのボタンやGUI)が使われます。
    3. loopCountが完了するか、loopCountのないアラートが1時間再生され、ローカルで停止します。

    サンプルメッセージ

    {
        "event": {
            "header": {
                "namespace": "Alerts",
                "name": "AlertStopped",
                "messageId": "{STRING}"
            },
            "payload": {
                "token": "{{STRING}}"
            }
        }
    }
    

    ヘッダーのパラメーター

    パラメーター 説明
    messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

    ペイロードのパラメーター

    パラメーター 説明
    token SetAlertディレクティブで提供される不透明なトークンです。 文字列

    AlertEnteredForegroundイベント

    AlertEnteredForegroundイベントは、アラートがフォアグラウンドになったとき(フル音量で再生)、または同時に発生したDialogチャンネル上の対話が完了したときに、クライアントからAVSに送信される必要があります。チャンネルでの対話についての具体的な詳細は、対話モデルを参照してください。

    サンプルメッセージ

    {
        "event": {
            "header": {
                "namespace": "Alerts",
                "name": "AlertEnteredForeground",
                "messageId": "{{STRING}}"
            },
            "payload": {
                "token": "{{STRING}}"
            }
        }
    }
    

    ヘッダーのパラメーター

    パラメーター 説明
    messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

    ペイロードのパラメーター

    パラメーター 説明
    token SetAlertディレクティブで提供される不透明なトークンです。 文字列

    AlertEnteredBackgroundイベント

    AlertEnteredBackgroundイベントは、Dialogチャンネル上で同時に対話が行われている間にアラートがフォアグラウンドではなくなったとき(音量が下がる、または一時停止する)に、クライアントからAVSに送信される必要があります。チャンネルでの対話についての具体的な詳細は、対話モデルを参照してください。

    サンプルメッセージ

    {
        "event": {
            "header": {
                "namespace": "Alerts",
                "name": "AlertEnteredBackground",
                "messageId": "{{STRING}}"
            },
            "payload": {
                "token": "{{STRING}}"
            }
        }
    }
    

    ヘッダーのパラメーター

    パラメーター 説明
    messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

    ペイロードのパラメーター

    パラメーター 説明
    token SetAlertディレクティブで提供される不透明なトークンです。 文字列

      Alertsインターフェースは、タイマー、アラームのセット、管理、キャンセルを行うのに使用するディレクティブとイベントを提供します。クライアントには、インターネット接続が失われた場合または製品に内蔵された時計がNTPと同期されない場合のために、タイマー、アラームの管理に必要なロジックを実装する必要があります。実装に関するその他の詳細は、Alertsの概要および対話モデルを参照してください。

      状態ダイアグラム

      以下のダイアグラムは、Alertsコンポーネントによって制御される状態の変化を表しています。ボックスはAlertsの状態、コネクターは遷移を示します。

      Alertsでは、以下の状態がサポートされます。

      IDLE:以前にセットされたアラートが鳴動するまで、Alertsコンポーネントはidle状態である必要があります。また、アラートが停止/終了した際にも、idle状態に戻る必要があります。これは、ユーザー音声、物理ボタンの押下、GUIアフォーダンスの結果として発生する可能性があります。

      FOREGROUND ALERT:クライアント上のアラートがすでにセットされているとした場合、Alertsは、アラートが開始され、AlertStartedイベントがAVSに送信されたら、idle状態からalert foreground状態に遷移する必要があります。

      これは、Alertsチャンネルがフォアグラウンドの場合、つまりDialogチャンネルが非アクティブの場合にのみ該当します。チャンネルおよびチャンネルの優先順位付けの詳細については、対話モデルを参照してください。

      アラートが音声、ボタン押下、GUIアフォーダンスにより停止されたら、Alertsコンポーネントはalert foreground状態からidle状態に遷移する必要があります。

      アラートの鳴動中にDialogチャンネルがアクティブになると、Dialogチャンネルがアクティブな間、Alertsコンポーネントはforeground alert状態からbackground alert状態に遷移する必要があります。Dialogチャンネルが非アクティブになったら、アラートが停止/終了するまでforeground alert状態に戻る必要があります。

      BACKGROUND ALERT:Alertsコンポーネントがbackground alert状態になるのは、Dialogチャンネルがアクティブになったときのみです。チャンネルおよびチャンネルの優先順位付けの詳細については、対話モデルを参照してください。

      Alertsの状態ダイアグラム
      クリックして拡大

      機能API

      Alertsインターフェースのバージョン1.0を使用するには、機能APIの呼び出し内で宣言する必要があります。詳細については、機能APIを参照してください。

      オブジェクトのサンプル

      {
          "type": "AlexaInterface",
          "interface": "Alerts",
          "version": "1.0"
      }
      

      Alertsのコンテキスト

      Alexaは、コンテキストが必要な各イベントで、ローカルに保存されたアラートのステータスがクライアントからレポートされることを想定しています。Alertsは、2つのリストに分類されます。 allAlertsactiveAlertsです。 allAlerts は、ローカルに保存されたすべてのアラートのリストです。 activeAlerts は、現在フォーカスのあるアラート、またはエンドユーザーに対して鳴動しているアラートのリストです。

      コンテキストのレポートの詳細については、コンテキストの概要を参照してください。

      サンプルメッセージ

      {
          "header": {
              "namespace": "Alerts",
              "name": "AlertsState"
          },
          "payload": {
              "allAlerts": [
                  {
                      "token": "{{STRING}}",
                      "type": "{{STRING}}",
                      "scheduledTime": "{{STRING}}"
                  }
              ],
              "activeAlerts": [
                  {
                      "token": "{{STRING}}",
                      "type": "{{STRING}}",
                      "scheduledTime": "{{STRING}}"
                  }
              ]
          }
      }
      

      ペイロードのパラメーター

      パラメーター 説明
      allAlerts allAlertsのキー/値ペア。 オブジェクト
      allAlerts.token アラートがセットされたときにAlexaによって返されるアラートトークンです。 文字列
      allAlerts.type アラートの種類を示します。
      有効な値:TIMER、ALARM、REMINDERです。
      文字列
      allAlerts.scheduledTime ISO 8601形式のアラートの設定時刻。 文字列
      activeAlerts activeAlertsのキー/値ペア。 オブジェクト
      activeAlerts.token 現在発生中のアラートのトークンです。 文字列
      activeAlerts.type アラートの種類を示します。
      有効な値:TIMERまたはALARM
      文字列
      activeAlerts.scheduledTime ISO 8601形式のアラートの設定時刻。 文字列

      SetAlertディレクティブ

      このディレクティブはクライアントに、特定の時間または時刻のタイマー、アラームをセットするよう指示します。クライアントは、アラートをセットする音声リクエストの結果として、またはAmazon Alexaアプリを使用して以前にセットされていたアラートが再度有効化されたときに、SetAlertディレクティブを受信することがあります。

      サンプルメッセージ

      {
          "directive": {
              "header": {
                  "namespace": "Alerts",
                  "name": "SetAlert",
                  "messageId": "{{STRING}}",
                  "dialogRequestId": "{{STRING}}"
              },
              "payload": {
                  "token": "{{STRING}}",
                  "type": "{{STRING}}",
                  "scheduledTime": "{{STRING}}"
              }
          }
      }
      

      ヘッダーのパラメーター

      パラメーター 説明
      messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列
      dialogRequestId 特定のRecognizeイベントの応答として送信されるディレクティブの関連付けに使用する一意のID 文字列

      ペイロードのパラメーター

      パラメーター 説明
      token アラートを一意に識別する不透明なトークンです。 文字列
      type アラートの種類を示します。認識されない値がクライアントに送信された場合、デフォルトのALARMに設定する必要があります。
      有効な値:TIMERALARM
      文字列
      scheduledTime ISO 8601形式のアラートの設定時刻。 文字列

      SetAlertSucceededイベント

      クライアントがアラートを正常にセットし、SetAlertディレクティブを受信した後、SetAlertSucceededイベントをAVSに送信する必要があります。

      サンプルメッセージ

      {
          "event": {
              "header": {
                  "namespace": "Alerts",
                  "name": "SetAlertSucceeded",
                  "messageId": "{{STRING}}"
              },
              "payload": {
                  "token": "{{STRING}}"
              }
          }
      }
      

      ヘッダーのパラメーター

      パラメーター 説明
      messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

      ペイロードのパラメーター

      パラメーター 説明
      token SetAlertディレクティブで提供される不透明なトークンです。 文字列

      SetAlertFailedイベント

      クライアントがアラートのセットに失敗した場合は、SetAlertディレクティブを受信した後、SetAlertFailedイベントをAVSに送信する必要があります。

      サンプルメッセージ

      {
          "event": {
              "header": {
                  "namespace": "Alerts",
                  "name": "SetAlertFailed",
                  "messageId": "{{STRING}}"
              },
              "payload": {
                  "token": "{{STRING}}"
              }
          }
      }
      

      ヘッダーのパラメーター

      パラメーター 説明
      messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

      ペイロードのパラメーター

      パラメーター 説明
      token SetAlertディレクティブで提供される不透明なトークンです。 文字列

      DeleteAlertディレクティブ

      このディレクティブは、既存のアラートを削除するようAVSからクライアントに送信されます。クライアントは、タイマー、アラームをキャンセル/削除する音声リクエストの結果として、またはAmazon Alexaアプリを使用して以前にセットされていたアラートが削除されたときに、DeleteAlertディレクティブを受信することがあります。

      サンプルメッセージ

      {
          "directive": {
              "header": {
                  "namespace": "Alerts",
                  "name": "DeleteAlert",
                  "messageId": "{{STRING}}",
                  "dialogRequestId": "{{STRING}}"
              },
              "payload": {
                  "token": "{{STRING}}"
              }
          }
      }
      

      ヘッダーのパラメーター

      パラメーター 説明
      messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列
      dialogRequestId 特定のRecognizeイベントの応答として送信されるディレクティブの関連付けに使用する一意のIDです。 文字列

      ペイロードのパラメーター

      パラメーター 説明
      token アラートを一意に識別する不透明なトークンです。 文字列

      DeleteAlertSucceededイベント

      クライアントが既存のアラートを正常に削除またはキャンセルすると、DeleteAlertディレクティブを受信した後、DeleteAlertSucceededイベントをAVSに送信する必要があります。

      サンプルメッセージ

      {
          "event": {
              "header": {
                  "namespace": "Alerts",
                  "name": "DeleteAlertSucceeded",
                  "messageId": "{{STRING}}"
              },
              "payload": {
                  "token": "{{STRING}}"
              }
          }
      }
      

      ヘッダーのパラメーター

      パラメーター 説明
      messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

      ペイロードのパラメーター

      パラメーター 説明
      token DeleteAlertディレクティブで提供される不透明なトークンです。 文字列

      DeleteAlertFailedイベント

      クライアントが既存のアラートの削除またはキャンセルに失敗した場合、DeleteAlertディレクティブを受信した後、DeleteAlertFailedイベントをAVSに送信する必要があります。

      サンプルメッセージ

      {
          "event": {
              "header": {
                  "namespace": "Alerts",
                  "name": "DeleteAlertFailed",
                  "messageId": "{{STRING}}"
              },
              "payload": {
                  "token": "{{STRING}}"
              }
          }
      }
      

      ヘッダーのパラメーター

      パラメーター 説明
      messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

      ペイロードのパラメーター

      パラメーター 説明
      token DeleteAlertディレクティブで提供される不透明なトークンです。 文字列

      AlertStartedイベント

      アラートが設定された時刻にトリガーされると、AlertStartedイベントをAVSに対して送信する必要があります。

      サンプルメッセージ

      {
          "event": {
              "header": {
                  "namespace": "Alerts",
                  "name": "AlertStarted",
                  "messageId": "{{STRING}}"
              },
              "payload": {
                  "token": "{{STRING}}"
              }
          }
      }
      

      ヘッダーのパラメーター

      パラメーター 説明
      messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

      ペイロードのパラメーター

      パラメーター 説明
      token SetAlertディレクティブで提供される不透明なトークンです。 文字列

      AlertStoppedイベント

      AlertStoppedイベントは、アクティブなアラートが停止した場合にAVSに送信される必要があります。アラートは以下の場合に停止します。

      1. DeleteAlertディレクティブを受信した場合。AlertStoppedイベントの送信後、クライアントは、DeleteAlertSucceededイベント、DeleteAlertFailedイベントのどちらでアラートが正常に削除されたかどうかをAVSに知らせる必要があります。この対話については、Alertsの概要で説明されています。
      2. アラートの停止には、物理コントロール(ハードウェアのボタンやGUI)が使われます。
      3. loopCountが完了するか、loopCountのないアラートが1時間再生され、ローカルで停止します。

      サンプルメッセージ

      {
          "event": {
              "header": {
                  "namespace": "Alerts",
                  "name": "AlertStopped",
                  "messageId": "{STRING}"
              },
              "payload": {
                  "token": "{{STRING}}"
              }
          }
      }
      

      ヘッダーのパラメーター

      パラメーター 説明
      messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

      ペイロードのパラメーター

      パラメーター 説明
      token SetAlertディレクティブで提供される不透明なトークンです。 文字列

      AlertEnteredForegroundイベント

      AlertEnteredForegroundイベントは、アラートがフォアグラウンドになったとき(フル音量で再生)、または同時に発生したDialogチャンネル上の対話が完了したときに、クライアントからAVSに送信される必要があります。チャンネルでの対話についての具体的な詳細は、対話モデルを参照してください。

      サンプルメッセージ

      {
          "event": {
              "header": {
                  "namespace": "Alerts",
                  "name": "AlertEnteredForeground",
                  "messageId": "{{STRING}}"
              },
              "payload": {
                  "token": "{{STRING}}"
              }
          }
      }
      

      ヘッダーのパラメーター

      パラメーター 説明
      messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

      ペイロードのパラメーター

      パラメーター 説明
      token SetAlertディレクティブで提供される不透明なトークンです。 文字列

      AlertEnteredBackgroundイベント

      AlertEnteredBackgroundイベントは、Dialogチャンネル上で同時に対話が行われている間にアラートがフォアグラウンドではなくなったとき(音量が下がる、または一時停止する)に、クライアントからAVSに送信される必要があります。チャンネルでの対話についての具体的な詳細は、対話モデルを参照してください。

      サンプルメッセージ

      {
          "event": {
              "header": {
                  "namespace": "Alerts",
                  "name": "AlertEnteredBackground",
                  "messageId": "{{STRING}}"
              },
              "payload": {
                  "token": "{{STRING}}"
              }
          }
      }
      

      ヘッダーのパラメーター

      パラメーター 説明
      messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

      ペイロードのパラメーター

      パラメーター 説明
      token SetAlertディレクティブで提供される不透明なトークンです。 文字列