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

Note: Sign in to the developer console to build or publish your skill.

Alexaからスキルに送られたリクエストを正常に処理できなかった場合は、Alexa.ErrorResponseイベントを返し、エラータイプとその理由を指定します。応答は同期または非同期のどちらでも返すことができますが、非同期で応答する場合、相関トークンと、スコープを指定した認可トークンを含めます。

エラータイプの値に記載されている一般的なエラーには、Alexa.ErrorResponseイベントを使用します。必要に応じて、次のいずれかのより具体的なエラーイベントを代わりに使用します：

ディレクティブを正常に処理できた場合は、代わりにAlexa.Responseイベントを使用して応答します。

ErrorResponseイベント

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

ErrorResponseイベントの形式

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

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

同期エラー応答

アマゾンウェブサービス（AWS）のLambda関数からディレクティブに応答する場合、同期応答を送信します。ディレクティブのリクエストの値を設定したcorrelationTokenを含めます。

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

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

{
  "event": {
    "header": {
      "namespace": "Alexa",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint":{
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "ENDPOINT_UNREACHABLE",
      "message": "エンドポイント12345にアクセスできません。オフラインの可能性があります"
    }
  }
}

非同期エラー応答

デバイス制御クラウドからディレクティブに応答する場合、Alexaイベントゲートウェイに非同期応答を送信します。相関トークンと、認可トークンを含めたスコープを含めます。詳細については、イベントゲートウェイにイベントを送信するを参照してください。非同期のAlexa.ErrorResponseをゲートウェイに送信する際、Alexaは成功か失敗かを示すHTTPステータスコードを送信します。

以下は、Alexaイベントゲートウェイに非同期的に送信するエラー応答の例です。エラータイプの一覧については、エラータイプの値を参照してください。

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

{
  "event": {
    "header": {
      "namespace": "Alexa",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint":{
      "scope":{
        "type":"BearerToken",
        "token":"access-token-from-Amazon"
      },
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "ENDPOINT_UNREACHABLE",
      "message": "エンドポイント12345にアクセスできません。オフラインの可能性があります。"
    }
  }
}

HTTPステータスコード

次の表は、スキルがAlexaイベントゲートウェイから受け取る可能性のあるHTTPステータスコードの一覧です。エラーを受け取った場合は、payloadオブジェクトにcodeフィールドとdescriptionフィールドが含まれます。これらのフィールドはログ記録の目的でのみ使用してください。

ステータス	ペイロードのコード	説明
`202 Accepted`	—	リクエストは認可され、メッセージは構文的に有効なイベントでした。ゲートウェイはイベントを受け付け、論理的な検証と処理に進みます。
`400 Bad Request`	`INVALID_REQUEST_EXCEPTION`	メッセージが無効です。フィールドがない、値が正しくない、正しいJSON形式ではないことが原因です。ドキュメントと照合して、メッセージにすべての必須フィールドが含まれていることを確認します。
`401 Unauthorized`	`INVALID_ACCESS_TOKEN_EXCEPTION`	メッセージに認可トークンが含まれていないか、トークンが無効、有効期限切れ、形式が正しくないのいずれかです。トークンを更新して、リクエストを再試行してください。ユーザーがスキルを無効にすると、アクセストークンも無効になります。この場合は、ユーザーが認可を取り消したため、変更レポートの送信も停止できます。
`403 Forbidden`	`SKILL_NEVER_ENABLED_EXCEPTION`	イベントゲートウェイへのアクセスが許可されていません。イベントを正しいリージョンのエンドポイントに送信していることを確認してください。たとえば、北米のイベントは北米のエンドポイントに送信します。
`403 Forbidden`	`INSUFFICIENT_PERMISSION_EXCEPTION`	トークンに必要な権限がありません。スキルにAlexaイベントを送信する権限があることを確認してください。詳細については、Alexaイベントゲートウェイへのアクセス権限のリクエストを参照してください。
`404 Not Found`	`ACCOUNT_NOT_FOUND_EXCEPTION`	指定されたIDに関連付けられたアカウントレコードが存在しないか、期限が切れています。このエラーは、イベントの送信が遅すぎた場合や、無効なIDが指定された場合に発生する可能性があります。指定されたIDと認可コードが正しいことを確認してください。
`404 Not Found`	`SKILL_NOT_FOUND_EXCEPTION`	このトークンに関連付けられたスキルIDが見つかりませんでした。このエラーは、スキルが認定中などの異なるステージにある状況でユーザーのアクセストークンが生成された場合に発生します。このユーザーでスキルの無効化と有効化を行ってみてください。
`413 Payload Too Large`	`REQUEST_ENTITY_TOO_LARGE_EXCEPTION`	イベントペイロードのサイズが大きすぎます。1回のリクエストで許容されるエンドポイントの最大数は300です。より小さいペイロードでメッセージを送信してください。
`429 Too Many Requests`	`THROTTLING_EXCEPTION`	リクエスト数が多すぎます。メッセージを再送してください。ただし、再送は最大3回までで、再送の間隔は1秒以上空けてください。
`500 Internal Server Error`	`INTERNAL_SERVICE_EXCEPTION`	Alexaでエラーが発生したため、メッセージは処理されませんでした。メッセージを再送してください。ただし、再送は最大3回までで、再送の間隔は1秒以上空けてください。問題が解消されない場合、Alexa開発者向け問い合わせ窓口にお問い合わせください。
`503 Service Unavailable`	`SERVICE_UNAVAILABLE_EXCEPTION`	Alexaがメッセージを受け取れませんでした。メッセージを再送してください。ただし、再送は最大3回までで、再送の間隔は1秒以上空けてください。問題が解消されない場合、Alexa開発者向け問い合わせ窓口にお問い合わせください。

応答本文401 Unauthorizedの例

以下は、エラー応答の例です。

HTTP/1.1 400 Bad Request
Date: Wed, 07 Mar 2018 20:25:31 GMT
Connection: close

{
  "header": {
    "namespace": "System",
    "name": "Exception",
    "messageId": "90c3fc62-4b2d-460c-9c8b-77251f1698a0"
  },
  "payload": {
      "code": "INVALID_ACCESS_TOKEN_EXCEPTION",
      "description": "アクセストークンが無効、有効期限切れ、形式が正しくないのいずれかです。"
  }
}

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

EventオブジェクトでAlexa.ErrorResponseを送信します。event.payloadパラメーターに以下の情報を含めます。

注：エラーのタイプによっては、ペイロードの内容が追加される場合があります。詳細については、エラータイプの値を参照してください。

プロパティ	説明	型	必須
`type`	エラーのタイプです。Alexaはこれをユーザーと共有します。	文字列	◯
`message`	エラー内容を説明するメッセージ。ログとデバッグのみが目的で、この情報はユーザーには共有されません。	文字列	◯

エラータイプの値

以下の表は、有効なエラータイプと、実行後に返す対応するエラーインターフェースを示しています。各エラータイプのパラメーターの詳細については、参照されるインターフェースを参照してください。特定のエラータイプをトラブルシューティングする際のヒントについては、スマートホームスキルのトラブルシューティングガイドを参照してください。

注：エラータイプが異なる場合、必ずしもAlexaが異なる応答を生成するとは限りません。

値	説明	インターフェース
`ALREADY_IN_OPERATION`	エンドポイントが既に稼動中であるため、リクエストされた処理を実行できません。	`Alexa.ErrorResponse`
`AUTHORIZATION_REQUIRED`	セキュリティシステムの現在の状態は`ARMED_AWAY`で、ユーザーがシステムを`ARMED_STAY`、`ARMED_NIGHT`として再起動しようとしています。	`Alexa.SecurityPanelController.ErrorResponse`
`BRIDGE_UNREACHABLE`	ブリッジが到達できない状態であるか、オフラインになっています。たとえば、ブリッジがオフになっている場合、ユーザーのローカルエリアネットワークから切断されている場合、ブリッジとデバイス制御クラウドの間の接続が失われている場合などです。`ReportState`ディレクティブに応答するときに、このエラーではなく`StateReport`を返さなければならないことがあります。詳細については、`Alexa.EndpointHealth`を参照してください。	`Alexa.ErrorResponse`
`BYPASS_NEEDED`	セキュリティパネルには開いているゾーンがあり、ユーザーはセキュリティシステムを起動する前に、ユーザーはこれを回避する必要があります。	`Alexa.SecurityPanelController.ErrorResponse`
`CLOUD_CONTROL_DISABLED`	ユーザーはインターネット経由でデバイスを制御できません。代わりに手動でデバイスを制御する必要があります。	`Alexa.ErrorResponse`
`CHILD_LOCK`	機器のチャイルドロックが有効になっています。	`Alexa.Cooking.ErrorResponse`
`CONFIGURATION_UPDATE_NOT_ALLOWED`	サーモスタットデバイスでは設定変更が許可されていません。設定変更を受け入れるには、ユーザーが直接デバイスを操作する必要があります。	`Alexa.ThermostatController.Configuration.ErrorResponse`
`COOK_DURATION_TOO_LONG`	リクエストされた時間が長すぎるため、機器を安全に稼働できません。	`Alexa.Cooking.ErrorResponse`
`COOLING_LOCKOUT_TEMPERATURE_VALUE_OUT_OF_RANGE`	冷却のロックアウト温度が受け入れ可能な範囲を超えています。	`Alexa.ThermostatController.Configuration.ErrorResponse`
`COOLING_STAGES_EXCEEDS_LIMIT`	冷却の段数が制限を超えています。	`Alexa.ThermostatController.Configuration.ErrorResponse`
`DATA_DELETION_NOT_SUPPORTED`	デバイスではデータの削除がサポートされません。	`Alexa.DataController.ErrorResponse`
`DATA_RETRIEVAL_NOT_SUPPORTED`	デバイスではデータの取得がサポートされません。	`Alexa.DataController.ErrorResponse`
`DEVICE_STUCK`	デバイスに物理的な問題があるため、要求されたアクションを実行できません。	`Alexa.ErrorResponse`
`DISABLED_BY_USER`	ユーザーがカメラアプリでスナップショット機能を無効にしたため、エンドポイントはスナップショットを提供できません。	`Alexa.SmartVision.SnapshotProvider.ErrorResponse`
`DO_NOT_DISTURB_MODE`	エンドポイントはおやすみモードになっており、リクエストされたディレクティブに応答できません。	`Alexa.ErrorResponse`
`DOOR_CLOSED_TOO_LONG`	最近ドアが開閉されていないため、機器が空の可能性があります。たとえば、食料がないときに調理を開始しようとした場合などが該当します。	`Alexa.Cooking.ErrorResponse`
`DOOR_OPEN`	機器のドアが開いています。たとえば、ドアが開いた状態で調理を開始しようとした場合などが該当します。	`Alexa.Cooking.ErrorResponse`
`DUAL_SETPOINTS_UNSUPPORTED`	サーモスタットは、現在のモードで2つの設定値をサポートしていません。	`Alexa.ThermostatController.ErrorResponse`
`ENDPOINT_BUSY`	エンドポイントが別のアクションを実行中のため、ディレクティブを処理できません。アクションは、Alexaへのリクエストや手動の操作の可能性があります。	`Alexa.ErrorResponse`
`ENDPOINT_CONTROL_UNAVAILABLE`	たとえば、自動車に接続されていないなどの理由で、現在エンドポイントを制御できません。コネクテッドカーの接続に問題がある場合は、このエラータイプを使用します。このエラー応答を送信する場合は、ペイロードに`reason`を含めてください。	`Alexa.ErrorResponse`
`ENDPOINT_LOW_POWER`	エンドポイントのバッテリー残量が足りないため、ディレクティブを処理できません。	`Alexa.ErrorResponse`
`ENDPOINT_UNREACHABLE`	エンドポイントが到達できない状態であるか、オフラインになっています。たとえば、エンドポイントがオフになっている場合、ユーザーのローカルエリアネットワークから切断されている場合、エンドポイントとブリッジまたはエンドポイントとデバイス制御クラウドの間の接続が失われている場合などです。`ReportState`ディレクティブに応答するときに、このエラーではなく`StateReport`を返さなければならないことがあります。詳細については、`Alexa.EndpointHealth`を参照してください。	`Alexa.ErrorResponse`
`EXCEEDED_PIN_ATTEMPTS`	ユーザーが誤ったPINを入力した回数が多すぎます。	`Alexa.AuthorizationController.ErrorResponse`
`EXPIRED_AUTHORIZATION_CREDENTIAL`	Alexaが提供する認可資格情報が期限切れです。ユーザーのOAuth2.0アクセストークンが期限切れになっている場合などです。	`Alexa.ErrorResponse`
`FAILED_TO_BOOTSTRAP_COMMISSIONING_PROCESS`	エンドポイントは到達可能ですが、ローカル接続ができません。Matterの場合は、エンドポイントがデバイスをコミッションモードに変更できなかったことを表します。	`Alexa.Commissionable.ReportCommissioningInformation`
`FIRMWARE_OUT_OF_DATE`	エンドポイントのファームウェアが期限切れになっているため、ディレクティブを処理できません。	`Alexa.ErrorResponse`
`HARDWARE_MALFUNCTION`	エンドポイントでハードウェアの故障が発生したため、ディレクティブを処理できません。	`Alexa.ErrorResponse`
`HEATING_LOCKOUT_TEMPERATURE_VALUE_OUT_OF_RANGE`	暖房のロックアウト温度が受け入れ可能な範囲を超えています。	`Alexa.ThermostatController.Configuration.ErrorResponse`
`HEATING_STAGES_EXCEEDS_LIMIT`	暖房の段数が制限を超えています。	`Alexa.ThermostatController.Configuration.ErrorResponse`
`INSUFFICIENT_PERMISSIONS`	Alexaには、指定されたアクションをエンドポイントで実行する権限がありません。	`Alexa.ErrorResponse`
`INSUFFICIENT_RESOURCE`	リクエストされた操作を完了するには、デバイスのリソースを補充または交換する必要があります。このエラー応答を送信する場合は、リソースを説明する`resourceType`をペイロードに含めてください。	`Alexa.ErrorResponse`
`INSUFFICIENT_SPACE`	サーモスタットに十分な容量がありません。このエラーは、ユーザーが大量のスケジュールを設定し、デバイスの制限を超えた場合に発生する可能性があります。	`Alexa.ThermostatController.Schedule.ErrorResponse`
`INTERNAL_ERROR`	ほかのエラータイプでは説明できないエラーが発生しました。ランタイム例外が発生した場合などがこれにあたりますが、可能な場合は、常に具体的なエラータイプを送信することを推奨します。スキルのエラーの場合、指定されるエラータイプが正確であるほど、Alexaが適切な手順や関連性の高い音声応答でユーザーを案内できる精度も高まります。	`Alexa.ErrorResponse`
`INVALID_AUTHORIZATION_CREDENTIAL`	Alexaが提供する認可資格情報が無効です。たとえば、ユーザーのデバイス制御クラウドアカウントでOAuth2.0アクセストークンが有効でない場合などです。	`Alexa.ErrorResponse`
`INVALID_AUXILIARY_HEATING_SYSTEM_TYPE`	指定された補助暖房システムがデバイスでサポートされていません。	`Alexa.ThermostatController.Configuration.ErrorResponse`
`INVALID_DIRECTIVE`	ディレクティブがこのスキルでサポートされていないか、正しくありません。	`Alexa.ErrorResponse`
`INVALID_SYSTEM_TYPE`	暖房、換気、空調（HVAC）は、システムタイプとしてデバイスでサポートされていません。	`Alexa.ThermostatController.Configuration.ErrorResponse`
`INVALID_TARGET_STATE`	対象の状態がデバイスでサポートされていません。	`Alexa.ThermostatController.Configuration.ErrorResponse`
`INVALID_TEMPERATURE_SCALE`	温度単位がデバイスでサポートされていません。	`Alexa.ThermostatController.Configuration.ErrorResponse`
`INVALID_TERMINAL_CONNECTION`	1つ以上の端子接続が無効です。	`Alexa.ThermostatController.Configuration.ErrorResponse`
`INVALID_VALUE`	ディレクティブに、ターゲットとするエンドポイントでは無効の値が含まれています。たとえば、暖房モード、チャンネル、リクエストされたオブジェクトクラスなどが無効の場合です。	`Alexa.ErrorResponse` `Alexa.SmartVision.ObjectDetectionSensor.ErrorResponse`
`MAINTENANCE_REQUIRED`	操作を開始する前にデバイスのメンテナンスが必要です。このエラー応答を送信する場合は、オプションとして、デバイスの修理方法を説明した`maintenanceAction`をペイロードに含めることができます。	`Alexa.ErrorResponse`
`MAX_COMMISSIONING_LIMIT_REACHED`	エンドポイントは、既に最大数のローカルハブにコミッションされています。	`Alexa.Commissionable.ReportCommissioningInformation`
`MISSING_SETUP_INFORMATION`	セットアップに必要な情報がディレクティブにありません。	`Alexa.ThermostatController.Configuration.ErrorResponse`
`NO_SUCH_ENDPOINT`	エンドポイントが存在しない、または存在しなくなりました。	`Alexa.ErrorResponse`
`NOT_CALIBRATED`	エンドポイントが較正中（暖機中など）のため、またはデバイスでまだユーザー設定が行われていないため、ディレクティブを処理できません。	`Alexa.ErrorResponse`
`NOT_IN_OPERATION`	エンドポイントが稼動していません。たとえば、スマートホームスキルが`RESUME`ディレクティブを受け取ったけれど、エンドポイントが`OFF`モードの場合、`NOT_IN_OPERATION`エラーを返すことができます。	`Alexa.ErrorResponse`
`NOT_READY`	セキュリティパネルは起動と解除の準備ができていません。このエラータイプは、インストールモードのセキュリティパネルをユーザーが制御しようとしたときに使用します。	`Alexa.SecurityPanelController.ErrorResponse`
`NOT_SUPPORTED_IN_CURRENT_MODE`	現在の操作モードが原因で、エンドポイントはデバイスを指定された値に設定できません。このエラー応答を送信する場合は、デバイスを新しい値に設定できない理由を示す`currentDeviceMode`フィールドをペイロードに含めてください。有効な値は、`COLOR`、`ASLEEP`、`NOT_PROVISIONED`、`OTHER`です。例については、`NOT_SUPPORTED_IN_CURRENT_MODE`を参照してください。	`Alexa.ErrorResponse`
`NOT_SUPPORTED_WITH_CURRENT_BATTERY_CHARGE_STATE`	現在のバッテリー状態では、エンドポイントはリクエストを実行できません。このエラー応答を送信する場合は、`CurrentChargeState`とオプションで`CurrentChargeLevelInPercentage`をペイロードに含めてください。	`Alexa.ErrorResponse`
`OBSTACLE_DETECTED`	障害物が検知されたため、エンドポイントでディレクティブを処理できません（ユーザーがドアを閉めようとしたときにドアを塞ぐような人や物があった場合など）。	`Alexa.Safety.ErrorResponse`
`PARTNER_APPLICATION_REDIRECTION`	エンドポイントはリクエストを処理できません。このエラーを受信すると、Alexaはユーザーにパートナーアプリを確認するようプロンプトを出します。	`Alexa.ErrorResponse`
`PIN_SETUP_REQUIRED`	ユーザーがまだPINコードを設定していません。	`Alexa.AuthorizationController.ErrorResponse`
`POWER_LEVEL_NOT_SUPPORTED`	エンドポイントがサポートしていない電力レベルの操作がリクエストされたため、ディレクティブを処理できません。	`Alexa.ErrorResponse`
`PREHEAT_REQUIRED`	機器は予熱する必要があります。	`Alexa.Cooking.ErrorResponse`
`PROBE_REQUIRED`	温度プローブを挿入する必要があります。	`Alexa.Cooking.ErrorResponse`
`RATE_LIMIT_EXCEEDED`	リクエストは、エンドポイントまたはブリッジがディレクティブを処理できる最大レートを超えています。	`Alexa.ErrorResponse`
`REMOTE_START_NOT_SUPPORTED`	リモート調理がデバイスでサポートされていません。	`Alexa.Cooking.ErrorResponse`
`REMOVE_PROBE`	温度プローブを取り外す必要があります。	`Alexa.Cooking.ErrorResponse`
`REMOTE_START_DISABLED`	リモート調理が無効になっていたため、調理の前に再度有効にする必要があります。	`Alexa.Cooking.ErrorResponse`
`REQUESTED_SETPOINTS_TOO_CLOSE`	2つの設定値の値が近すぎます。	`Alexa.ThermostatController.ErrorResponse`
`SAFETY_BEAM_BREACHED`	セーフティビームで侵入を検知したためエンドポイントはディレクティブを処理できません（エレベーターのドアが閉まるときにドアのセーフティビームの前を人が横切った場合など）。	`Alexa.Safety.ErrorResponse`
`SUBSCRIPTION_REQUIRED`	サブスクリプションが必要なため、リクエストされたオブジェクトクラスは有効にされませんでした。	`Alexa.SmartVision.ObjectDetectionSensor.ErrorResponse` `Alexa.SmartVision.SnapshotProvider.ErrorResponse`
`TEMPERATURE_VALUE_OUT_OF_RANGE`	指定された温度値は、許容される温度の範囲外です。このエラー応答を送信する場合は、オプションとして、有効な温度範囲を示す`validRange`オブジェクトをペイロードに含めることができます。例については、`TEMPERATURE_VALUE_OUT_OF_RANGE`を参照してください。	`Alexa.ErrorResponse`
`THERMOSTAT_IS_OFF`	サーモスタットがオフで、オンにできません。	`Alexa.ThermostatController.ErrorResponse`
`TOO_MANY_FAILED_ATTEMPTS`	パスワード入力時などに許容される失敗回数を超えています。	`Alexa.ErrorResponse`
`TRIPLE_SETPOINTS_UNSUPPORTED`	サーモスタットは、現在のモードで3つの設定値をサポートしていません。	`Alexa.ThermostatController.ErrorResponse`
`UNABLE_TO_CHARGE`	技術的な問題でエンドポイントが充電できないため、ディレクティブリクエストを実行できません。	`Alexa.ErrorResponse`
`UNAUTHORIZED`	PINコードが正しくありません。	`Alexa.AuthorizationController.ErrorResponse` `Alexa.SecurityPanelController.ErrorResponse`
`UNCLEARED_ALARM`	セキュリティパネルにアクティブなアラームがあり、ユーザーが起動しようとしています。	`Alexa.SecurityPanelController.ErrorResponse`
`UNSUPPORTED_THERMOSTAT_MODE`	サーモスタットは、指定されたモードをサポートしていません。	`Alexa.ThermostatController.ErrorResponse`
`UNCLEARED_TROUBLE`	セキュリティパネルに問題があります。	`Alexa.SecurityPanelController.ErrorResponse`
`UNWILLING_TO_SET_SCHEDULE`	サーモスタットは、指定されたスケジュールを設定できません。	`Alexa.ThermostatController.ErrorResponse`
`UNWILLING_TO_SET_VALUE`	サーモスタットは、デバイスや機器に損傷を与える恐れがあるため、この値を設定できません。	`Alexa.ThermostatController.ErrorResponse`
`VALUE_OUT_OF_RANGE`	指定された値は許容範囲外です。たとえば、ユーザーが100を超えるパーセンテージ値をリクエストした場合にこのエラーを使用できます。温度値には、代わりに`TEMPERATURE_VALUE_OUT_OF_RANGE`を使用します。このエラー応答を送信する場合は、オプションとして、有効な数値範囲を示す`validRange`オブジェクトをペイロードに含めることができます。例については、`VALUE_OUT_OF_RANGE`を参照してください。	`Alexa.ErrorResponse`

ErrorResponseの例

以下の例は、追加のプロパティを含むエラータイプのペイロードを示しています。

ENDPOINT_CONTROL_UNAVAILABLE

以下は、ENDPOINT_CONTROL_UNAVAILABLEエラータイプのエラー応答の例です。制御できない理由を示すreason文字列をペイロードに含めます。エラータイプの一覧については、エラータイプの値を参照してください。

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

{
  "event": {
    "header": {
      "namespace": "Alexa",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
       "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint":{
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "ENDPOINT_CONTROL_UNAVAILABLE",
      "message": "車の接続パッケージが有効になっていません。",
      "reason": "NO_CONNECTIVITY_PACKAGE_ENABLED"
    }
  }
}

ENDPOINT_LOW_POWER

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

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

{
  "event": {
    "header": {
      "namespace": "Alexa",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint": {
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "ENDPOINT_LOW_POWER",
      "message": "ロックのバッテリー残量が足りません",
      "percentageState": 5
    }
  }
}

NOT_SUPPORTED_IN_CURRENT_MODE

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

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

{
  "event": {
    "header": {
      "namespace": "Alexa",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint": {
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "NOT_SUPPORTED_IN_CURRENT_MODE",
      "message": "照明は現在、カラーに設定されています。",
      "currentDeviceMode": "COLOR"
    }
  }
}

NOT_SUPPORTED_WITH_CURRENT_BATTERY_CHARGE_STATE

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

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

{
  "event": {
    "header": {
      "namespace": "Alexa",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint": {
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "NOT_SUPPORTED_WITH_CURRENT_BATTERY_CHARGE_STATE ",
      "message":"車は充電されていました",
      "currentChargeState": "ALREADY_CHARGED_TO_REQUIRED_LEVEL",
      "currentChargeLevelInPercentage": 75
    }
  }
}

TEMPERATURE_VALUE_OUT_OF_RANGE

以下は、TEMPERATURE_VALUE_OUT_OF_RANGEエラータイプのエラー応答の例です。設定可能な最低／最高温度を指定したvalidRangeオブジェクトをペイロードに含めます。

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

{
  "event": {
    "header": {
      "namespace": "Alexa",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint": {
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "TEMPERATURE_VALUE_OUT_OF_RANGE",
      "message": "リクエストされた温度-15は範囲外です。",
      "validRange": {
        "minimumValue": {
          "value": 15.0,
          "scale": "CELSIUS"
        },
        "maximumValue": {
          "value": 30.0,
          "scale": "CELSIUS"
        }
      }
    }
  }
}

VALUE_OUT_OF_RANGE

以下は、VALUE_OUT_OF_RANGEエラータイプのエラー応答の例です。設定可能な最小／最大値を指定したvalidRangeオブジェクトをペイロードに含めます。

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

{
  "event": {
    "header": {
      "namespace": "Alexa",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "リクエストに一致するopaque相関トークン",
      "payloadVersion": "3"
    },
    "endpoint":{
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "VALUE_OUT_OF_RANGE",
      "message": "100を超えるパーセンテージ値は設定できません。",
      "validRange": {
        "minimumValue": 0,
        "maximumValue": 100
      }
    }
  }
}

プロパティとオブジェクト

一部のエラータイプでは、ペイロードに次のオブジェクトが含まれます。詳細については、エラータイプの値を参照してください。

CurrentChargeLevelInPercentageプロパティ

NOT_SUPPORTED_WITH_CURRENT_BATTERY_CHARGE_STATEエラー応答を送信する際は、currentChargeLevelInPercentageプロパティをペイロードに含めます。currentChargeLevelInPercentageは、バッテリーレベルをパーセンテージで示します。有効な値は 0～100です。このプロパティはオプションです。

以下の例は、CurrentChargeLevelInPercentageプロパティの例を示しています。

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

{
  "currentChargeLevelInPercentage": "100"
}

CurrentChargeStateプロパティ

NOT_SUPPORTED_WITH_CURRENT_BATTERY_CHARGE_STATEエラー応答を送信する際は、currentChargeStateプロパティをペイロードに含めます。currentChargeStateは、バッテリーの現在の状態を示します。

以下の表は、バッテリー状態の有効な値を示しています。

バッテリー状態	説明
`ALREADY_CHARGED_TO_REQUIRED_LEVEL`	車のバッテリーレベルはリクエストされたレベルより高いです。
`CURRENTLY_CHARGING`	車のバッテリーは充電中です。
`FULLY_CHARGED`	車のバッテリーレベルは100%です。
`NOT_CONNECTED_TO_POWER`	車のバッテリーが充電器に接続されていません。

MaintenanceAction

MAINTENANCE_REQUIREDエラー応答を送信する際は、必要な修理を指定したmaintenanceActionプロパティをペイロードに含めることができます。このプロパティはオプションです。

プロパティ	説明
`EMPTY_BIN`	ゴミ容器を手動で空にする必要があるロボット掃除機などのデバイスで使用します。

Reasonの値

ENDPOINT_CONTROL_UNAVAILABLEエラー応答を送信する際は、エンドポイントを制御できない理由を示すreasonプロパティをペイロードに含めます。

プロパティ	説明
`DEEP_SLEEP_MODE`	ディープスリープモードは、コネクテッドカーなどのエンドポイントのユーザー定義の設定です。ユーザーは、このモードをオフにすることで、この問題を解決できる可能性があります。
`OUT_OF_NETWORK_CONNECTIVITY`	エンドポイントは、ネットワーク接続サービスの範囲外にあります。
`NO_CONNECTIVITY_PACKAGE_ENABLED`	エンドポイントを利用するには、ユーザーがインターネットプランを購入するか有効にする必要があります。
`UNKNOWN`	不明な理由により、デバイス制御クラウドがエンドポイントに接続できません。

ResourceTypeの値

INSUFFICIENT_RESOURCEエラー応答を送信する際は、交換するリソースを示すresourceTypeプロパティをペイロードに含めます。

プロパティ	説明
`WATER`	水拭き機能付きロボット掃除機などのデバイスで、タンクの残量が少ないか、空になっています。

ValidRangeオブジェクト

VALUE_OUT_OF_RANGEエラー応答を送信する際は、設定可能な最小および最大の値を示すvalidRangeオブジェクトをペイロードに含めます。このプロパティはオプションです。

以下は、ValidRangeオブジェクトの例です。

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

{
  "validRange": {
    "minimumValue": 0,
    "maximumValue": 100
  }
}

温度を含むValidRangeオブジェクト

TEMPERATURE_VALUE_OUT_OF_RANGEエラー応答を送信する際は、設定可能な最小および最大の温度を示すvalidRangeオブジェクトをペイロードに含めます。最大値と最小値は、temperatureオブジェクトを含みます。このプロパティはオプションです。

以下は、温度を指定したValidRangeオブジェクトの例です。

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

{
  "validRange": {
    "minimumValue": {
      "value": 15.0,
      "scale": "CELSIUS"
    },
    "maximumValue": {
      "value": 30.0,
      "scale": "CELSIUS"
    }
  }
}

このページは役に立ちましたか？

フィードバックを送信

最終更新日: 2025 年 05 月 30 日

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

ErrorResponseイベント

ErrorResponseイベントの形式

同期エラー応答

非同期エラー応答

HTTPステータスコード

応答本文401 Unauthorizedの例

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

エラータイプの値

ErrorResponseの例

ENDPOINT_CONTROL_UNAVAILABLE

ENDPOINT_LOW_POWER

NOT_SUPPORTED_IN_CURRENT_MODE

NOT_SUPPORTED_WITH_CURRENT_BATTERY_CHARGE_STATE

TEMPERATURE_VALUE_OUT_OF_RANGE

VALUE_OUT_OF_RANGE

プロパティとオブジェクト

CurrentChargeLevelInPercentageプロパティ

CurrentChargeStateプロパティ

MaintenanceAction

Reasonの値

ResourceTypeの値

ValidRangeオブジェクト

温度を含むValidRangeオブジェクト

関連トピック

このページは役に立ちましたか？