Alexa.Safety.ErrorResponseインターフェース3
Note: Sign in to the developer console to build or publish your skill.
Alexa.Safety.ErrorResponseインターフェース3
安全上の問題でAlexaからスキルに送られたディレクティブを正常に処理できない場合は、Alexa.Safety.ErrorResponse
イベントを返します。
重要:
Alexa.ErrorResponse
とこのインターフェースのペイロードバージョンが異なる場合があります。応答するインターフェースのペイロードバージョンを使用するようにしてください。ErrorResponseイベント
Alexa.Safety.ErrorResponse
のペイロードには、エラータイプを指定し、エラー情報のメッセージを含めます。Alexa.Safety
のエラータイプの一覧については、エラータイプの値を参照してください。エラー応答は、同期応答または非同期応答で送信できます。詳細については、Alexa.ErrorResponse
を参照してください。
ErrorResponseイベントのペイロードのプロパティ
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
type |
エラーのタイプです。Alexaはこれをユーザーと共有します。 | 文字列 | ◯ |
message |
エラーのエラーメッセージです。この情報はユーザーとは共有されません。 | 文字列 | ◯ |
注: エラーのタイプによっては、ペイロードの内容が追加される場合があります。詳細については、エラータイプの値を参照してください。
ErrorResponseイベントの形式
{
"event": {
"header": {
"namespace": "Alexa.Safety",
"name": "ErrorResponse",
"messageId": "一意の識別子、バージョン4 UUIDが望ましい",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0ベアラートークン"
},
"endpoint":{
"endpointId": "エンドポイントID"
},
},
"payload": {
"type": "エラータイプ",
"message": "エラーメッセージ"
}
}
}
エラータイプの値
以下の表は、有効なAlexa.Safety
エラータイプの一覧です。
エラータイプ | 説明 |
---|---|
OBSTACLE_DETECTED |
障害物が検知されたため、エンドポイントでディレクティブを処理できません(ユーザーがドアを閉めようとしたときにドアを塞ぐような人や物があった場合など)。 |
SAFETY_BEAM_BREACHED |
セーフティビームで侵入を検知したためディレクティブを処理できません(エレベーターのドアが閉まるときにドアのセーフティビームの前を人が横切った場合など)。こちらの例を参照してください。 |
Alexa.Safety
エラータイプに加えて、Alexaエラータイプも使用できます。詳細については、Alexa.ErrorResponseエラータイプの値を参照してください。
Alexa.Safety.ErrorResponseの例
以下の例は、さまざまなエラータイプのペイロードを示しています。
OBSTACLE_DETECTED
以下は、OBSTACLE_DETECTED
エラータイプのエラー応答例です。
{
"event": {
"header": {
"namespace": "Alexa.Safety",
"name": "ErrorResponse",
"messageId": "一意の識別子、バージョン4 UUIDが望ましい",
"correlationToken": "リクエストに一致するopaque相関トークン",
"payloadVersion": "3"
},
"endpoint":{
"endpointId": "エンドポイントID"
},
"payload": {
"type": "OBSTACLE_DETECTED",
"message": "途中に障害物があります。"
}
}
}
SAFETY_BEAM_BREACHED
以下は、SAFETY_BEAM_BREACHED
エラータイプのエラー応答例です。Alexa.Safety
のエラータイプの一覧については、エラータイプの値を参照してください。
{
"event": {
"header": {
"namespace": "Alexa.Safety",
"name": "ErrorResponse",
"messageId": "一意の識別子、バージョン4 UUIDが望ましい",
"correlationToken": "リクエストに一致するopaque相関トークン",
"payloadVersion": "3"
},
"endpoint": {
"endpointId": "エンドポイントID"
},
"payload": {
"type": "SAFETY_BEAM_BREACHED",
"message": "セーフティビームが侵入を検知しました。"
}
}
}
関連トピック
- Alexa.ErrorResponse
- Alexa.Cooking.ErrorResponse
- Alexa.SecurityPanelController.ErrorResponse
- Alexa.ThermostatController.ErrorResponse
- Alexa.Video.ErrorResponse
最終更新日: 2024 年 07 月 03 日