Alexa.Commissionable.ReportCommissioningInformation.ErrorResponseインターフェース 1.0
Alexaが、スキルにAlexa.Commissionable.ReportCommissioningInformation
ディレクティブを送信し、スキルがこのディレクティブを処理できない場合、ReportCommissioningInformation.ErrorResponse
イベントを使って応答します。詳細については、Alexa.Commissionable
インターフェースを参照してください。
Alexa.ErrorResponse
とこのインターフェースのペイロードバージョンが異なる場合があります。応答するインターフェースのペイロードバージョンを使用するようにしてください。ErrorResponseイベント
ReportCommissioningInformation.ErrorResponse
のペイロードでは、エラータイプを指定し、エラー情報のメッセージを含めます。ReportCommissioningInformation
のエラータイプの一覧については、エラータイプの値を参照してください。エラー応答は、同期応答または非同期応答で送信できます。詳細については、Alexa.ErrorResponse
を参照してください。
ReportCommissioningInformation.ErrorResponseのペイロードのプロパティ
次の表は、Alexa.Commissionable.ReportCommissioningInformation
のエラー応答ペイロードを示しています。
プロパティ | 説明 | 型 | 必須 |
---|---|---|---|
|
スキルがコミッション情報を返す際に参照するエラータイプの値です。 |
文字列 |
◯ |
|
エラーの説明です。 |
文字列 |
✕ |
ErrorResponseイベントの形式
{
"event": {
"header": {
"namespace": "Alexa.Commissionable",
"name": "ReportCommissioningInformation.ErrorResponse",
"messageId": "一意の識別子、バージョン4 UUIDが望ましい",
"payloadVersion": "1.0"
},
"endpoint": {
"endpointId": "エンドポイントID"
},
"payload": {
"type": "エラータイプ",
"message": "エラーメッセージ"
}
}
}
エラータイプの値
次の表は、有効なAlexa.Commissionable.ReportCommissioningInformation
のエラータイプを示しています。
値 | 説明 |
---|---|
|
エンドポイントは、既に最大数のローカルハブにコミッションされています。 |
|
エンドポイントは到達可能ですが、ローカル接続ができません。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": "エンドポイントは、既に最大数のローカルハブにコミッションされています。"
}
}
}
関連トピック
最終更新日: 2022 年 12 月 02 日