あなたのAlexaコンソール
?
サポート

APIの概要

Alexa Voice Serviceの概要(v20160207)

Alexa Voice Service (AVS)は、開発者がマイクとスピーカーを搭載したコネクテッドデバイスを音声に対応させることのできるサービスです。AVSを統合すると、楽曲の再生、タイマーやアラーム、荷物の追跡、上映中の映画の一覧、カレンダー管理といったAlexaのビルトイン機能やAlexa Skills Kitを使用して開発したサードパーティ製のスキルに、製品からアクセスできるようになります。

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

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

更新内容

  • 2018/1/31 - AVSをオーストラリアとニュージーランドで利用できるようになりました。詳細を見る »
  • 2018/1/30 - AVSで以下の2点が変更されました。これらの更新では、製品のクライアントコードへの変更が必要となります。1) 音声によって起動されるすべての製品でクラウドベースのウェイクワード検証が必須となりました。2) ExpectSpeechディレクティブ内のinitiatorのデータ型がstringからobjectに変更されました。詳細を見る »
  • 2017/12/6 - SetAlertディレクティブとAlertStoppedイベントに関するドキュメントにガイダンスが追加されました。
  • 2017/12/6 - INACTIVEからACTIVEへのストリーミング状態遷移を明確にするため、BluetoothStateを更新しました。
  • 2017/11/8 - 日本語のドキュメントが利用可能になりました。テストするには、このページの末尾にある言語切り替えをお試しください。開発向けサービスの利用開始日は2017/11/15です。詳細を見る »
  • 2017/8/17 - C++向けAVSデバイスSDKが利用可能になりました。詳細を見る »

認可

製品からAVS APIにアクセスするには、ユーザーに代わって製品からAPIを呼び出せるようにするLogin with Amazon (LWA)アクセストークンを取得する必要があります。製品の認可には複数の方法があります。

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

ローカル認可は、AVSが使えるデバイスからAlexaの認可を行うのに使用します。通常、ローカル認可はAndroidやiOSのアプリケーションで使用されます。

コードベースのリンクは、テレビやスマートウォッチといった文字入力が制限される、あるいは文字入力の手段を持たない製品に最適な認可方法です。

転送プロトコル

以下のページでは、接続の管理やリクエストの構成に役立つ情報が提供されています。

エンドポイント

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

リージョン サポートされる国 URL
アジア オーストラリア、日本、ニュージーランド https://avs-alexa-fe.amazon.com
ヨーロッパ オーストリア、ドイツ、インド、英国 https://avs-alexa-eu.amazon.com
北米 カナダ、米国 https://avs-alexa-na.amazon.com

インターフェース

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

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

バージョン管理

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

以下は、現行バージョン、旧バージョン、移行ガイドの一覧です。

現行バージョン

旧バージョン

ヘルプが必要な場合

疑問点やコメントがある場合やAVS APIで問題が発生した場合は、AVSのフォーラムとナレッジベースを利用できます。Amazonではこれらのサイトを積極的にモニタリングして、開発者様のフィードバックや懸念点に対応しています。