Alexaインターフェース3

Alexaインターフェース3

Alexaインターフェースは、すべてのスキルが使用するAlexaの基本的なメッセージを定義する、Alexaスキルの最上位インターフェースです。これらのAPIには、一般的なAlexaディレクティブ、応答イベント、検出、状態レポート、変更レポート、エラーレポートが含まれます。詳細については、メッセージのリファレンスを参照してください。

使用できるすべてのAlexa機能インターフェースについては、Alexaインターフェースの一覧を参照してください。メッセージプロパティの定義については、Alexaインターフェースのメッセージとプロパティを参照してください。

すべてのスキルでAlexaインターフェースをサポートする

Discover.ResponseとAddOrUpdateReportイベントメッセージで、Alexaインターフェースのサポートを明示的に指定する必要があります。検出インターフェースの詳細については、Alexa.Discoveryインターフェースを参照してください。

以下は、Alexa.PowerControllerをサポートするエンドポイントへの検出応答の例です。Alexaインターフェースのサポートを明示的に指定します。その他の検出の例については、各インターフェースのドキュメントを参照してください。

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

{
  "event": {
    "header": {
      "namespace": "Alexa.Discovery",
      "name": "Discover.Response",
      "payloadVersion": "3",
      "messageId": "一意の識別子、バージョン4 UUIDが望ましい"
    },
    "payload": {
      "endpoints":[
        {
          "endpointId": "エンドポイントの一意のID",
          "manufacturerName": "エンドポイントのメーカー名",
          "description": "Alexaアプリに表示される説明",
          "friendlyName": "Alexaアプリに表示されているデバイス名",
          "displayCategories": ["LIGHT"],
          "cookie": {},
          "capabilities": [
            {
              "type": "AlexaInterface",
              "interface": "Alexa.PowerController",
              "version": "3",
              "properties": {
                "supported": [
                  {
                    "name": "powerState"
                  }
                ],
                "proactivelyReported": true,
                "retrievable": true
              }
            },
            {
              "type": "AlexaInterface",
              "interface": "Alexa",
              "version": "3"
            }
          ]
        }
      ]
    }
  }
}

ディレクティブと応答

各機能インターフェースに定義されているディレクティブとイベントに加えて、Alexaインターフェースでは次の基本ディレクティブとイベントを定義します。

  • AcceptGrantディレクティブ – Alexaはユーザーを識別して認証する認証情報をスキルに提供します。
  • Discoverディレクティブ – Alexaはユーザーエンドポイントの機能をリクエストします。
  • ReportStateディレクティブ – Alexaは、スマートホームスキルまたはビデオスキルに接続されたデバイスの状態をアナウンスまたは表示します。
  • AddOrUpdateReportイベント – ユーザーがスキルに接続されているデバイスを追加または更新したら、Alexaにイベントを送信して新しいデバイスや更新されたデバイスについて知らせます。
  • DeleteReportイベント – ユーザーがスマートホームスキルに接続されたデバイスを削除したら、イベントを送信してAlexaにデバイスが存在しなくなったことを知らせます。
  • StateReport応答 – スキルは、状態レポートディレクティブに対する状態レポート応答を返して、Alexaにスキルが制御するデバイスの状態を知らせます。
  • ChangeReportイベント – デバイスの状態が変更されたら、プロアクティブに変更レポートイベントを送信します。
  • Responseイベント – インターフェース固有のディレクティブに応答を送信します。
  • DeferredResponseイベント – 特定のディレクティブの後に遅延応答を送信して、実際の応答を後で送信することをAlexaに知らせます。
  • ErrorResponse – インターフェース固有のディレクティブを処理できない場合、エラー応答を送信してエラーの理由を知らせます。

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

最終更新日: 2024 年 12 月 02 日