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

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

Alexaからスキルに送られたビデオディレクティブを正常に処理できない場合は、Alexa.Video.ErrorResponseイベントを返します。

ErrorResponseイベント

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

ErrorResponseイベントの形式

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

{
"event": {
    "header": {
      "namespace": "Alexa.Video",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "ディレクティブで受信した相関トークン",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "OAuth2ベアラートークン"
      },
      "endpointId" :  "エンドポイントのエンドポイントID" ,
    },
    "payload": {
      "type": "エラータイプ",
      "message": "エラーメッセージ"
    }
  }
}

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

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

フィールド 説明 型 必須
type エラーのタイプです。Alexaはこれをユーザーと共有します。 文字列 ◯
message エラーのエラーメッセージです。この情報はユーザーには共有されません。 文字列 ◯

エラータイプの値

以下の表は、Alexa.Video名前空間の有効なエラータイプを示しています。

型 説明

ACTION_NOT_PERMITTED_FOR_CONTENT

コンテンツではリクエストされたアクションが許可されていないことを示します。たとえば、削除不可とマークされている録画をユーザーが削除しようとした場合などです。

CONFIRMATION_REQUIRED

リクエストされたアクションを完了するには、追加の確認が必要なことを示します。

CONTENT_NOT_RECORDABLE

コンテンツの制約により録画操作が失敗したことを示します。

NOT_SUBSCRIBED

チャンネルやそのほかのサブスクリプションベースのコンテンツに、ユーザーが登録していないことを示します。

RECORDING_EXISTS

録画が既に存在するために録画リクエストが失敗したことを示します。

STORAGE_FULL

DVRストレージに空き容量がないために録画リクエストが失敗したことを示します。

TITLE_DISAMBIGUATION_REQUIRED

指定されたタイトルで候補が複数見つかり、録画する番組を決定するにはあいまいさを解消する必要があることを示します。この値は、対象のデバイスにあいまいさ解消のメカニズムがあることを示すのに使用します。たとえば、このエラーは放送される番組が複数あるか、録画をリクエストされたエンティティに関連付けられた番組が複数あることなどを示します。

TUNER_OCCUPIED

別の録画とスケジュールが競合するため、録画リクエストが失敗したことを示します。

応答例

同期応答の例

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

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

{
  "event": {
    "header": {
      "namespace": "Alexa.Video",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "ディレクティブで受信した相関トークン",
      "payloadVersion": "3"
    },
    "endpoint":{
      "endpointId": "エンドポイントID"
    },
    "payload": {
      "type": "CONTENT_NOT_RECORDABLE",
      "message": "Alexaがログを記録するエラーについての参考情報です。"
      }
  }
}

非同期応答の例

以下は、Alexaイベントゲートウェイに非同期的に送信するエラー応答の例です。非同期で応答する場合、相関トークンと、認可トークン付きのスコープを含めます。詳細については、イベントゲートウェイにイベントを送信するを参照してください。

Alexa.Videoのエラータイプの一覧については、エラータイプの値を参照してください。

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

{
  "event": {
    "header": {
      "namespace": "Alexa.Video",
      "name": "ErrorResponse",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい",
      "correlationToken": "ディレクティブで受信した相関トークン",
      "payloadVersion": "3"
    },
    "endpoint":{
      "scope":{
        "type": "BearerToken",
        "token": "OAuth2ベアラートークン"
      },
      "endpointId": "エンドポイントID"
    },
    "payload": {
        "type": "CONTENT_NOT_RECORDABLE",
        "message": "Alexaがログを記録するエラーについての参考情報です。"
    }
  }
}