Alexa.Commissionable.ReportCommissioningInformation.ErrorResponseインターフェース 1.0

Alexa.Commissionable.ReportCommissioningInformation.ErrorResponseインターフェース1.0

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

ErrorResponseイベント

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

ReportCommissioningInformation.ErrorResponseのペイロードのプロパティ

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

プロパティ 説明 型 必須

type

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

文字列

◯

message

エラーの説明です。

文字列

✕

ErrorResponseイベントの形式

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

{
    "event": {
        "header": {
            "namespace": "Alexa.Commissionable",
            "name": "ReportCommissioningInformation.ErrorResponse",
            "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
            "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.Commissionable.ReportCommissioningInformation.ErrorResponseの例

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

MAX_COMMISSIONING_LIMIT_REACHED

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

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

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

Last updated: Dec 02, 2022