Alexa.Commissionable.ReportCommissioningInformation.ErrorResponseイベント

Alexa.Commissionable.ReportCommissioningInformation.ErrorResponseイベント

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

ErrorResponseイベント

ReportCommissioningInformation.ErrorResponseのペイロードでは、エラータイプを指定し、エラー情報のメッセージを含めます。ReportCommissioningInformationのエラータイプの一覧については、エラータイプの値を参照してください。

ReportCommissioningInformation.ErrorResponseのペイロード

次の表は、Alexa.Commissionable.ReportCommissioningInformationのエラー応答ペイロードを示しています。

プロパティ 説明 型 必須

type

スキルがコミッション情報を返す際に参照するエラータイプの値です。

文字列

◯

message

エラーの説明です。

文字列

✕

ErrorResponseイベントの形式

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

{
    "event": {
        "header": {
            "namespace": "Alexa.Commissionable",
            "name": "ReportCommissioningInformation.ErrorResponse",
            "messageId": "メッセージID",
            "payloadVersion": "1.0"
        },
        "endpoint": {
            "endpointId": "エンドポイントの一意ID"
        },
        "payload": {
            "type": "エラータイプ",
            "message": "エラーメッセージ"
        }
    }
}

エラータイプの値

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

値 説明

MAX_COMMISSIONING_LIMIT_REACHED

エンドポイントは、既に最大数のローカルハブにコミッションされています。

FAILED_TO_BOOTSTRAP_COMMISSIONING_PROCESS

エンドポイントは到達可能ですが、ローカル接続ができません。Matterの場合は、エンドポイントがデバイスをコミッションモードに変更できなかったことを表します。

ReportCommissioningInformationのエラータイプに加え、ENDPOINT_BUSY、ENDPOINT_UNREACHABLE、BRIDGE_UNREACHABLEといったAlexaの標準エラータイプを使うこともできます。詳細については、Alexa ErrorResponseイベントのエラータイプの値を参照してください。

例

同期応答の例

以下は、Alexaに同期的に送信するエラー応答の例です。Alexa.Commissionable.ReportCommissioningInformationのエラータイプの一覧については、エラータイプの値を参照してください。

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

{
  "event": {
    "header": {
      "namespace": "Alexa.Commissionable",
      "name": "ReportCommissioningInformation.ErrorResponse",
      "messageId": "＜一意の識別子、バージョン4 UUIDが望ましい＞",
      "payloadVersion": "1.0"
    },
    "endpoint":{
      "endpointId": "エンドポイントの一意ID"
    },
    "payload": {
      "type": "MAX_COMMISSIONING_LIMIT_REACHED",
      "message": "エンドポイントは、既に最大数のローカルハブにコミッションされています。"
    }
  }
}

非同期応答の例

以下は、Alexaイベントゲートウェイに非同期的に送信するエラー応答の例です。非同期で応答する場合、相関トークンと、認可トークン付きのスコープを含めます。詳細については、イベントゲートウェイにイベントを送信するを参照してください。

Alexa.Commissionable.ReportCommissioningInformationのエラータイプの一覧については、エラータイプの値を参照してください。

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

{
  "event": {
    "header": {
      "namespace": "Alexa.Commissionable",
      "name": "ReportCommissioningInformation.ErrorResponse",
      "messageId": "＜一意の識別子、バージョン4 UUIDが望ましい＞",
      "correlationToken": "opaque相関トークン",
      "payloadVersion": "1.0"
    },
    "endpoint":{
      "scope":{
        "type":"BearerToken",
        "token":"access-token-from-Amazon"
      },
      "endpointId": "エンドポイントの一意ID"
    },
    "payload": {
      "type": "MAX_COMMISSIONING_LIMIT_REACHED",
      "message": "エンドポイントは、既に最大数のローカルハブにコミッションされています。"
    }
  }
}