あなたのAlexaダッシュボード 設定

APIの概要

Alexa Voice Serviceの概要(v20160207)

Alexa Voice Service(AVS)を使用すると、開発者はマイクおよびスピーカーに接続された製品を音声に対応させることができます。統合すると、製品はAlexaの標準機能(楽曲再生、タイマーとアラーム、パッケージ追跡、映画のリスト表示、カレンダー管理など)やAlexa Skills Kitを使用して開発されたサードパーティスキルにアクセスできるようになります。

AVSは、音声認識、オーディオ再生、音量コントロールなどのクライアント機能に対応するインターフェースで構成されています。各インターフェースには、ディレクティブおよびイベントと呼ばれる、論理的にグループ分けされたメッセージが含まれます。ディレクティブは、クラウドからクライアントに送信されるメッセージで、クライアントにアクションを実行するよう指示するものです。イベントは、クライアントからクラウドに送信されるメッセージで、Alexaに対して何かが発生したことを通知するものです。

APIは、製品の認可にLogin with Amazon(LWA)を使用し、HTTP/2エンドポイントを提供します。

更新情報

  • 2017年11月8日 - 日本のエンドポイントは11月15日から利用可能です。 詳細はこちら≫
  • 2017年8月17日 - AVS Device SDK for C++が利用可能になりました。詳細はこちら≫
  • 2017年8月10日 - 製品が対応する必要のある推奨のコーデック、コンテナ、ストリーミング形式、プレイリストが、AVSで推奨されるメディアサポートから入手可能になりました。
  • 2017年8月7日 - SpeechRecognizerのドキュメントで、ユーザーとの対話中にマイクをどれくらいの時間オープンにしておく必要があるかが明記されました。
  • 2017年8月3日 -SetAlertディレクティブが、名前付きのタイマーとリマインダーをサポートするよう拡張されました。
    詳細はこちら≫

認可

製品からAVS APIにアクセスするには、ユーザーに代わって製品からAPIにアクセスできるようにするLogin with Amazon(LWA)アクセストークンを取得する必要があります。製品を認可するには、以下の2つの方法があります。

リモート認可は、コンパニオンウェブサイトまたはモバイルアプリを使用してデバイスを認可する場合に使用されます。通常、リモート認可は、スマートスピーカーなどのヘッドレスデバイスで使用されます。

ローカル認可は、AVS対応製品からAlexaを認可する場合に使用します。通常、ローカル認可はAndroidおよびiOSアプリケーションで使用されます。

転送プロトコル

以下のページでは、接続を管理し、リクエストを構成するための情報を提供します。

エンドポイント

AVSは、HTTP/2サービスを提供し、HTTP/2用にエンコードされたマルチパートメッセージを受け取ります。以下のエンドポイントがサポートされます。

リージョン 対応している国 URL
North America 米国 https://avs-alexa-na.amazon.com
Europe 英国、ドイツ, インド https://avs-alexa-eu.amazon.com
Asia 日本 https://avs-alexa-fe.amazon.com

インターフェース

各インターフェースは、それぞれ特定のクライアント側の機能に対応するディレクティブとイベントで構成されています。以下の表に詳細を示します。

インターフェース 説明
SpeechRecognizer Alexa Voice Serviceのコアインターフェース。ユーザーの各発話はRecognizeイベントを利用します。
SpeechSynthesizer Alexa TTSを返すインターフェース。
Alerts タイマーとアラームの設定、停止、削除のインターフェース。概念的な概要については、Alertsの概要を参照してください。
AudioPlayer Alexaが管理するキューからのオーディオ再生の管理と制御を行うインターフェース。概念的な概要については、AudioPlayerの概要を参照してください。
Bluetooth(開発者プレビュー) スマートフォンやスピーカーなどのピアBluetoothデバイスとの接続を管理するインターフェース。
Notifications 通知が利用可能なことを知らせるビジュアルおよびオーディオのインジケーターを提供するインターフェース。概念的な概要については、Notificationsの概要を参照してください。
PlaybackController ボタン押下やGUIアフォーダンスを介した再生キューのナビゲーションを行うインターフェース。
Settings ロケールなど、製品上でAlexa設定を管理するために使用するインターフェース。
Speaker ミュートおよびミュート解除を含む、製品上でのAlexaからのコンテンツの音量を制御するためのインターフェース。
System Alexaに製品についての情報を送信するのに使用するインターフェース。
TemplateRuntime ビジュアルメタデータのレンダリングに使用するインターフェース。概念的な概要については、表示カードの概要を参照してください。

バージョン管理

Amazonでは、新機能、パフォーマンス強化、バグフィックスを追加してAlexaユーザーに最高のエクスペリエンスを提供するために、AVS APIを定期的にアップデートしています。これらの変更により、JSONで新しいディレクティブやプロパティの送信が必要になる場合がありますが、既存のディレクティブとプロパティとの後方互換性は維持されます。その他の情報については、対話モデルを参照してください。

現行バージョン、前バージョン、および移行ガイドを以下に示します。

現行バージョン

前バージョン

ヘルプが必要な場合

AVS APIに関して質問、コメントがある場合、問題が発生した場合は、AVSナレッジベースおよびフォーラムを活用してください。Amazonでは、頻繁にモニタリングし、開発者のフィードバックや懸念事項に対応しています。