Alexa.SmartVision.SnapshotProvider.ErrorResponseインターフェース1.1

Alexa.SmartVision.SnapshotProvider.ErrorResponseインターフェース1.1

Alexaからスキルに送信されたAlexa.SmartVision.SnapshotProviderディレクティブを正しく処理できなかった場合は、Alexa.SmartVision.SnapshotProvider.ErrorResponseイベントで応答します。詳細については、Alexa.SmartVision.SnapshotProviderを参照してください。

ErrorResponseイベント

Alexa.SmartVision.SnapshotProvider.ErrorResponseのペイロードには、エラータイプを指定し、エラーメッセージとその情報を含めます。Alexa.SmartVision.SnapshotProviderのエラータイプの一覧については、エラータイプの値を参照してください。エラー応答は、同期応答または非同期応答で送信できます。非同期で応答する場合、相関トークンと、認可トークンを含めたスコープを付与します。エラーレポートの詳細については、Alexa.ErrorResponseを参照してください。

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

プロパティ 説明 型 必須

type

エラーのタイプです。Alexaはこれをユーザーと共有します。

文字列

◯

message

エラーを説明するメッセージです。この情報はユーザーには共有されません。

文字列

◯

ErrorResponseイベントの形式

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

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

エラータイプの値

以下の表は、有効なAlexa.SmartVision.SnapshotProviderエラータイプの一覧です。

プロパティ 説明

SUBSCRIPTION_REQUIRED

必要なサブスクリプションがないため、エンドポイントはスナップショットを提供できません。

DISABLED_BY_USER

ユーザーがカメラアプリでスナップショット機能を無効にしたため、エンドポイントはスナップショットを提供できません。

スナップショット機能固有のエラーではない場合は、Alexa.Smartvision.SnapshotProvider.ErrorResponseエラータイプのほかにも、一般的なAlexa.ErrorResponseイベントで応答することもできます。

Alexa.SmartVision.SnapshotProvider.ErrorResponseの例

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

SUBSCRIPTION_REQUIRED

SUBSCRIPTION_REQUIREDエラータイプのエラー応答例を次に示します。

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

{
    "event": {
        "header": {
            "namespace": "Alexa.SmartVision.SnapshotProvider",
            "name": "ErrorResponse",
            "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
            "correlationToken": "リクエストに一致するopaque相関トークン",
            "payloadVersion": "1.1"
        },
        "endpoint": {
            "scope": {
                "type": "BearerToken",
                "token": "access-token-from-HAQM"
            },
            "endpointId": "エンドポイントID"
        },
        "payload": {
            "type": "SUBSCRIPTION_REQUIRED",
            "message": "必要なサブスクリプションがないため、スナップショット機能を有効にできません"
        }
    }
}

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

最終更新日: 2025 年 04 月 16 日