Alexa.SecurityPanelController.ErrorResponseインターフェース 3

Alexa.SecurityPanelController.ErrorResponseインターフェース3

Alexaから送信されたAlexa.SecurityPanelControllerディレクティブを正しく処理できなかった場合、スキルはAlexa.SecurityPanelController.ErrorResponseイベントで応答します。詳細については、Alexa.SecurityPanelControllerインターフェースを参照してください。

ErrorResponseイベント

Alexa.SecurityPanelController.ErrorResponseのペイロードには、エラータイプを指定し、エラー情報のメッセージを含めます。Alexa.SecurityPanelControllerのエラータイプの一覧については、エラータイプの値を参照してください。エラー応答は、同期応答または非同期応答で送信できます。詳細については、Alexa.ErrorResponseを参照してください。

ErrorResponseイベントのペイロードのプロパティ

フィールド 説明 型 必須
type エラーのタイプです。Alexaはこれをユーザーと共有します。 文字列 ◯
message エラーのエラーメッセージです。この情報はユーザーとは共有されません。 文字列 ◯

ErrorResponseイベントの形式

クリップボードにコピーされました。

{
"event": {
    "header": {
      "namespace": "Alexa.SecurityPanelController",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint":{
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "エラータイプ",
      "message": "エラーメッセージ"
    }
  }
}

エラータイプの値

次の表は、有効なAlexa.SecurityPanelControllerエラータイプの値を示しています。

値 説明
AUTHORIZATION_REQUIRED セキュリティシステムの現在の状態はARMED_AWAYで、ユーザーがシステムをARMED_STAY、ARMED_NIGHTとして再起動しようとしています。こちらの例を参照してください。詳細については、セキュリティシステムの起動を参照してください。
BYPASS_NEEDED セキュリティパネルには開いているゾーンがあり、ユーザーはセキュリティシステムを起動する前に、ユーザーはこれを回避する必要があります。ユーザーに音声コマンドを使用してエラーを回避させたい場合、エラー応答のペイロードのendpointsNeedingBypassフィールドに、回避の必要なエンドポイントのリストを含めてください。各エンドポイントにフレンドリー名を指定して、Alexaがユーザーに伝えられるようにします。Alexa.ContactSensorインターフェースとAlexa.MotionSensorインターフェースを実装するセンサーのendpointIdを含めます。エラー応答のペイロードにエンドポイントのリストを含めない場合、Alexaはユーザーに手動で回避するよう伝えます。こちらの例を参照してください。詳細については、音声オプションによる回避を参照してください。
NOT_READY セキュリティパネルは起動と解除の準備ができていません。セキュリティパネルがインスタレーションモードのときに、ユーザーがセキュリティパネルを制御しようとしている場合に、このエラータイプを使用します。
UNAUTHORIZED PINコードが正しくありません。
UNCLEARED_ALARM セキュリティパネルにアクティブなアラームがあり、ユーザーが起動しようとしています。こちらの例を参照してください。
UNCLEARED_TROUBLE セキュリティパネルに問題があります。

Alexa.SecurityPanelControllerエラータイプに加えて、Alexaエラータイプも使用できます。詳細については、Alexa.ErrorResponseエラータイプの値を参照してください。

Alexa.SecurityPanelController.ErrorResponseの例

以下の例は、さまざまなエラータイプのペイロードを示しています。

UNAUTHORIZED

以下は、UNAUTHORIZEDエラータイプのエラー応答例です。

クリップボードにコピーされました。

{
  "event": {
    "header": {
      "namespace": "Alexa.SecurityPanelController",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint":{
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "UNAUTHORIZED",
      "message": "PINコードが正しくありません。"
    }
  }
}

AUTHORIZATION_REQUIRED

以下は、AUTHORIZATION_REQUIREDエラータイプのエラー応答例です。ユーザーが、システムの解除を行うことなく、ARMED_AWAYからARMED_NIGHTまたはARMED_STAYに直接切り替えようとした場合に、このエラータイプを使用します。詳細については、セキュリティシステムの起動を参照してください。

クリップボードにコピーされました。

{
  "event": {
    "header": {
      "namespace": "Alexa.SecurityPanelController",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
          "type": "BearerToken",
          "token": "OAuth2.0ベアラートークン"
      },
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "AUTHORIZATION_REQUIRED",
      "message": "リクエストされた起動状態を設定する前にシステムを解除する必要があります。"
    }
  }
}

BYPASS_NEEDED

以下は、BYPASS_NEEDEDエラータイプのエラー応答例です。開いているゾーンのエラーがあり、ユーザーがシステムを起動するためにエラーを回避する必要がある場合に、このエラータイプを使用します。この例では、ユーザーが音声でエラーを回避できるよう、回避の必要なエンドポイントのリストを提供します。詳細については、音声オプションによる回避を参照してください。

クリップボードにコピーされました。

{
  "event": {
    "header": {
      "namespace": "Alexa.SecurityPanelController",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
          "type": "BearerToken",
          "token": "OAuth2.0ベアラートークン"
      },
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "BYPASS_NEEDED",
      "message": "センサーが開いているため、セキュリティパネルを起動できません。",
      "endpointsNeedingBypass": [
        {
          "friendlyName": "側面窓のセンサー",
          "endpointId": "エンドポイントID"
        },
        {
          "friendlyName": "玄関ドアのセンサー",
          "endpointId": "エンドポイントID"
        },
        {
          "friendlyName": "水センサー"
        }
      ]
    }
  }
}

UNCLEARED_ALARM

以下は、UNCLEARED_ALARMエラータイプのエラー応答例です。ユーザーが、アクティブアラーム状態にあるシステムを起動しようとした場合にこのエラータイプを使用します。

クリップボードにコピーされました。

{
  "event": {
    "header": {
      "namespace": "Alexa.SecurityPanelController",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
          "type": "BearerToken",
          "token": "OAuth2.0ベアラートークン"
      },
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "UNCLEARED_ALARM",
      "message": "アラームステータスにあるため、セキュリティパネルの起動または解除ができません。"
    }
  }
}