エンドポイントAPI

エンドポイントAPI

エンドポイントは、Alexaユーザーが操作できるAlexaコネクテッドデバイス（Echoデバイスなど）を表します。Alexa Smart Properties in Senior Livingでは、Alexa Smart Properties in Senior LivingエンドポイントAPIを使用して、Echoデバイスを管理します。このAPIを使用すると、Amazonビジネスアカウントで所有されているデバイスの列挙、設定の表示と変更、エンドポイントと特定のルームの関連付けを行うことができます。

APIエンドポイント

エンドポイントAPIのエンドポイントは、北米の施設の場合はhttps://api.amazonalexa.com、欧州の施設の場合はhttps://api.eu.amazonalexa.comです。

認証

すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値にはLogin with Amazon（LWA）から取得したアクセストークンが入ります。

操作

エンドポイントAPIには、以下の操作が用意されています。

操作 HTTPメソッドとURI

すべてのエンドポイントを取得する

GET /v2/endpoints?owner=~caller

1つのエンドポイントを取得する

GET /v2/endpoints/{endpointId}?expand=all

associatedUnitsを更新する

PUT /v2/endpoints/{endpointId}/associatedUnits

features/connectivityを取得する

GET /v2/endpoints/{endpointId}/features/connectivity

saveWifiConfigurationsを実行する

POST /credentiallocker/v2/saveWifiConfigurations

addOrUpdateWifi Configurationsを実行する

POST /v2/endpoints/endpointId/features/connectivity/addOrUpdateWifiConfigurations

Wi-Fiのインストールステータスを取得する

GET /v2/endpoints/endpointId/features/connectivity/addOrUpdateWifiConfigurations/submittedOperations/{operationId}

features/colorを取得する

GET /v2/endpoints/{endpointId}/features/color

features/colorを設定する

POST /v2/endpoints/{endpointId}/features/color/setColor

features/brightnessを取得する

GET /v2/endpoints/{endpointId}/features/brightness

features/brightnessを設定する

POST /v2/endpoints/{endpointId}/features/brightness/setBrightness

features/colorTemperatureを取得する

GET /v2/endpoints/{endpointId}/features/colorTemperature

features/colorTemperatureを設定する

POST /v2/endpoints/{endpointId}/features/colorTemperature/setColorTemperature

features/powerを取得する

GET /v2/endpoints/{endpointId}/features/power

features/powerを設定する

POST /v2/endpoints/{endpointId}/features/power/turnOn
POST /v2/endpoints/{endpointId}/features/power/turnOff

features/temperatureSensorを取得する

GET /v2/endpoints/{endpointId}/features/temperatureSensor

features/thermostatを取得する

GET /v2/endpoints/{endpointId}/features/thermostat

features/speakerを取得する

GET /endpoints/{endpointID}/features/speaker

features/speakerを設定する

POST /v2/endpoints/{endpointId}/features/speaker/setVolume
POST /v2/endpoints/{endpointId}/features/speaker/adjustVolume

エンドポイントの設定値を照会する

GET /v2/endpoints/{endpointId}/settings/{settingName}

エンドポイントの単一の設定を照会する

GET /v2/endpoints/{endpointId}/settings/{settingName}

エンドポイントの複数の設定を照会する

GET /v2/endpoints/{endpointId}/settings?keys={settingNames}&nextToken={nextToken}&maxResults={maxResults}

addressの設定を取得する

GET /v2/endpoints/{endpointId}/settings/address

DoNotDisturbの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Alexa.DoNotDisturb.doNotDisturb

localesの設定を取得する

GET /v2/endpoints/{endpointId}/settings/System.locales

WakeWordsの設定を取得する

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWords

wakeWordConfirmationの設定を取得する

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWordConfirmation

SpeechConfirmationの設定を取得する

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.speechConfirmation

errorSuppressionの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.errorSuppression

setupModePrivilegesの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.setupModePrivileges

maximumVolumeLimitの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.maximumVolumeLimit

timeZoneの設定を取得する

GET /v2/endpoints/{endpointId}/settings/System.timeZone

temperatureUnitの設定を取得する

GET /v2/endpoints/{endpointId}/settings/System.temperatureUnit

distanceUnitsの設定を取得する

GET /v2/endpoints/{endpointId}/settings/System.distanceUnits

AlexaCaptionsの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Accessibility.Captions.AlexaCaptions.enablement

ClosedCaptionsの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Accessibility.Captions.ClosedCaptions.enablement

Magnifierの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Accessibility.Display.Magnifier.enablement

ColorInversionの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Accessibility.Display.ColorInversion.enablement

複数の設定を取得する

GET /v2/endpoints/{endpointId}/settings?keys={settingNames}&nextToken={nextToken}&maxResults={maxResults}

FollowUpの設定を取得する

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.FollowUp.mode

speakingRateの設定を取得する

GET /v2/endpoints/{endpointId}/settings/SpeechSynthesizer.speakingRate

エンドポイントの設定値を更新する

PUT /v2/endpoints/{endpointId}/settings/{settingName}

addressの設定を更新する

POST /v2/endpoints/{endpointId}/settings/address

DoNotDisturbの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Alexa.DoNotDisturb.doNotDisturb

localesの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/System.locales

wakeWordsの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWords

wakeWordConfirmationの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWordConfirmation

speechConfirmationの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.speechConfirmation

errorSuppressionの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.errorSuppression

setupModePrivilegesの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.setupModePrivileges

maximumVolumeLimitの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.maximumVolumeLimit

timeZoneの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/System.timeZone

temperatureUnitの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/System.temperatureUnit

distanceUnitsの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/System.distanceUnits

AlexaCaptionsの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Captions.AlexaCaptions.enablement

ClosedCaptionsの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Captions.ClosedCaptions.enablement

Magnifierの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Display.Magnifier.enablement

ColorInversionの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Display.ColorInversion.enablement

FollowUpの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.FollowUp.mode

speakingRateの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/SpeechSynthesizer.speakingRate

エンドポイントの登録を解除する

POST /v2/endpoints/{endpointId}/deregister

エンドポイントのフレンドリー名を変更する

POST /v2/endpoints/{endpointId}/friendlyName

エンドポイントの情報を削除する

POST /v2/endpoints/{endpointId}/forget

複数のエンドポイントを取得する

以下の操作により、複数のエンドポイントの情報を取得できます。

すべてのエンドポイントを取得する

Amazonビジネスアカウントに登録したエンドポイントのリストを取得します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエスト

GET /v2/endpoints?owner=~callerを呼び出すと、Amazonビジネスアカウントに登録したエンドポイントのリストを取得できます。

リクエストの形式の例
ユニットに関連付けられていないエンドポイントをすべて取得する

次の例では、ユニットと関連付けられていない呼び出し元に所有されているエンドポイントのリストが返されます。デフォルトでは結果は展開されません。

この呼び出しでは、どのユニットにも関連付けられていないエンドポイントのみが返されます。特定のユニットに関連付けられているすべてのエンドポイントを取得するには、ユニットに関連付けられているすべてのエンドポイントを取得するを参照してください。

GET /v2/endpoints?owner=~caller HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

各エンドポイントの詳細を含める

この例では、各エンドポイントの詳細を含める方法を示します。次のexpand=allパラメーターを使用します。

GET /v2/endpoints?owner=~caller&expand=all HTTP/1.1

各エンドポイントの接続を含める

各エンドポイントのconnectivityの詳細を含めるには、次のexpand=feature:connectivityパラメーターを使用します。

GET /v2/endpoints?owner=~caller&expand=all&expand=feature:connectivity

ユニットに関連付けられているすべてのエンドポイントを取得する

呼び出し元がアクセス権限を持っている特定のunitIdに関連付けられているエンドポイントをすべて取得するには、associatedUnits.id={unitId}パラメーターを指定します。

GET /v2/endpoints?associatedUnits.id={unitId}&expand=all

リクエストのクエリパラメーター

フィールド 説明 型 必須
owner 呼び出し元が所有するエンドポイントのみに絞り込みます。現在サポートされている値は"~caller"のみで、これはベアラートークンに含まれるユーザー情報を表します。
注：ownerフィルターまたはassociatedUnits.idフィルターのいずれかを含める必要があります。		 文字列 ◯（associatedUnitsまたはserialNumber.value.textフィルターが指定されていない場合）
associatedUnits.id 特定のユニットに関連付けられているエンドポイントのみに絞り込みます。 文字列 ◯（ownerまたはserialNumber.value.textフィルターパラメーターが指定されていない場合）
nextToken 結果の次のページを取得するためのトークンです。詳細については、クエリ結果のページ分割を処理するを参照してください。 文字列 ✕
maxResults 表示する結果の最大数。値は1〜50の間で指定します。デフォルトは10です。 整数 ✕
expand 応答に含めるアトリビュート（またはアトリビュートのセット）。現在サポートされている値：all、feature:brightness、feature:color、feature:colorTemperature、feature:speaker、feature:temperatureSensor、feature:thermostat、feature:power、feature:connectivity。
注： expandには複数の値を指定できます。例：expand=all&expand=feature.connectivity		 文字列 ✕
manufacturer.value.text 指定された値のテキスト全体とmanufacturer.value.textが完全に一致するエンドポイントのみに絞り込みます。
注： このフィールドにフィルターをかけるには、応答にこのフィールドが含まれている必要があります。例：expand=All		 文字列 ✕
model.value.text 指定された値のテキスト全体とmodel.value.textが完全に一致するエンドポイントのみに絞り込みます。 文字列
注： このフィールドにフィルターをかけるには、応答にこのフィールドが含まれている必要があります。例：expand=All		 ✕
serialNumber.value.text 指定された値のテキスト全体とserialNumber.value.textが完全に一致するエンドポイントのみに絞り込みます。
注： このフィールドにフィルターをかけるには、応答にこのフィールドが含まれている必要があります。例：expand=All		 文字列 ◯（ownerまたはassociatedUnitsフィルターパラメーターが指定されていない場合）
friendlyName.value.text 指定された値のテキスト全体とfriendlyName.value.textが完全に一致するエンドポイントのみに絞り込みます。
注： このフィールドにフィルターをかけるには、応答にこのフィールドが含まれている必要があります。例：expand=All		 文字列 ✕
connections.macAddress 指定された値とmacAddressが完全に一致するエンドポイントのみに絞り込みます。
注： このフィールドにフィルターをかけるには、応答にこのフィールドが含まれている必要があります。例：expand=All		 文字列 ✕
features[name:connectivity].properties[name:reachability].value.value 指定された値とreachabilityが完全に一致するエンドポイントのみに絞り込みます。
注： これには、expandにfeatureが指定されている必要があります。例：expand=feature:connectivity。API呼び出しでこのフィルターを使用する方法の例については、この後のリクエストの例を参照してください。		 文字列 ✕
displayCategories.primary.value 指定された値と主要な表示カテゴリーが一致するエンドポイントのみに絞り込みます。 文字列 ✕
displayCategories.all.value 指定された値と表示カテゴリーが一致するエンドポイントのみに絞り込みます。 文字列 ✕

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文のパラメーター

フィールド 説明 型 必須
results クエリへの応答で返されたエンドポイントのリスト。
注： このリストの順番は、リクエストで指定されたクエリパラメーターによって異なる場合があります。		 リスト ◯
id エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯
manufacturer NameValueオブジェクト形式の、エンドポイントのメーカー。 オブジェクト ✕
model NameValueオブジェクト形式の、エンドポイントのモデル。 オブジェクト ✕
serialNumber NameValueオブジェクト形式の、エンドポイントのシリアル番号。 オブジェクト ✕
friendlyName NameValueオブジェクト形式の、エンドポイントのフレンドリー名。 オブジェクト ✕
softwareVersion NameValueオブジェクト形式の、エンドポイントのソフトウェアのバージョン。 オブジェクト ✕
connections Connectionオブジェクトのリストの形式で表された、エンドポイントがインターネットおよびスマートホームハブへの接続に使用できる方法。エンドポイントと関連付けられている接続がない場合、このフィールドは空になります。 リスト ✕
creationTime エンドポイントのリソースが初めて作成された日時。 ISO 8601形式の日付 ✕
features このエンドポイントのFeatureオブジェクトのリスト。 リスト ✕
associatedUnits エンドポイントが関連付けられているユニットを表すUnitオブジェクトのリスト。リクエストでexpand=allが指定されている場合にのみ返されます。エンドポイントに関連付けられているユニットがない場合、このリストは空になります。 リスト ✕
operations サポートされている操作を表すOperationのリスト。 リスト ✕
displayCategories displayCategoriesオブジェクト。    
paginationContext paginationContextオブジェクト。これがある場合、応答に含まれている結果は不完全です。ない場合は、すべての結果が既に返されています。 オブジェクト ✕

NameValueオブジェクト

フィールド 説明 型
type 名前の値のタイプ。現在サポートされている値は、"PLAIN"のみです。これは、valueプロパティにこのプロパティのplaintext値が格納されていることを示します。 文字列
value 名前の値。Valueオブジェクトとして指定します。 オブジェクト

例

"model": {
    "type": "PLAIN",
    "value": {
        "text":"Amazon Echo"
    }

Valueオブジェクト

フィールド 説明 型
text 文字列値。 文字列

Connectionオブジェクト

フィールド 説明 型
type 接続の種類。サポートされている値： TCP_IP、ZIGBEE、UNKNOWN。 文字列
macAddress ネットワークインターフェースコントローラーの一意の識別子。 文字列

例

{
  "type": "TCP_IP",
  "macAddress": "141AC1534151"
}

Featureオブジェクト

フィールド 説明 型
type 機能の名前。例："volume"、"speaker"。 文字列
path この機能の展開された結果を取得するために使用する完全なパス。例："/v2/endpoints/{endpointID}/features/speaker"。 文字列

例

{
    "name": "speaker",
    "path" : "/v2/endpoints/amzn1.alexa.endpoint.ABC123.../features/speaker"
}

Unitオブジェクト

フィールド 説明 型
id ユニットID。"amzn1.alexa.unit.did.{id}"形式で指定します。 文字列

例

{
  "id": "amzn1.alexa.unit.did.AFOVR3XKY2EZPRXZ7HURGMCRN7CQKHO45MBSNTYYB2YHD3L7I2C32SI2OLKYZJUQL"
}

displayCategoriesオブジェクト

フィールド 説明 型
primary エンドポイントの主要なカテゴリー。 displayCategoryオブジェクト。
all エンドポイントのすべてのカテゴリー。 配列

例

"displayCategories": {
   "primary": {
      "value": "ALEXA_VOICE_ENABLED",
      "sources": [
         "ENDPOINT_REPORTER"
      ]
   },
   "all": [
      {
         "value": "ALEXA_VOICE_ENABLED",
         "sources": [
            "ENDPOINT_REPORTER"
         ]
      }
   ]
}

displayCategoryオブジェクト

フィールド 説明 型
value 文字列形式のカテゴリー。 文字列
sources この表示カテゴリーのソース。"CUSTOMER"は、ユーザーが明示的にこの値を設定したことを意味します。"ENDPOINT_REPORTER"は、元のエンドポイントレポートの中でこの値が報告されたことを意味します。 配列

例

{
  "value": "LIGHT",
  "sources": ["CUSTOMER", "ENDPOINT_REPORTER"]
}

paginationContextオブジェクト

フィールド 説明 型
nextToken nextTokenの値を次回のリクエストで継続トークン（nextTokenクエリパラメーター）に指定すると、結果の次のページを取得できます。詳細については、クエリ結果のページ分割を処理するを参照してください。 文字列

例

{
  "nextToken": "ABCD123"
}

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージ。エラーメッセージの表示はデバッグやログ記録のみを目的としたものであり、ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
400 Bad Request リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden アクセストークンは有効ですが、必要なLWAスコープの権限をユーザーが持っていません。
429 Too many requests リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行します。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は500以外の応答を受信するまで256秒ごとに再試行します。
503 Service Unavailable サービスが一時的に使用できません。

1つのエンドポイントを取得する

1つのエンドポイントと、呼び出し元がアクセス権限を持つすべてのエンドポイントアトリビュートのリストの値を取得します。

呼び出し元にそのエンドポイントへのアクセス権限がある必要があります。このリクエストにはownerなどのフィルタリングパラメーターは必要ありません。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエスト

GET /v2/endpoints/{endpointId}?expand=allを呼び出すと、1つのエンドポイントと、呼び出し元がアクセス権限を持つすべてのエンドポイントアトリビュートのリストの値を取得できます。

リクエストの形式の例

以下の例では、この呼び出しの使い方を示します。

エンドポイントIDのみのリストを取得する

次の例では、エンドポイントのエンドポイントIDのみのリストを取得できます。

GET /v2/endpoints/{endpointId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

{
    "id": "amzn1.alexa.endpoint.A234ajd9..."
}
すべてのアトリビュートのリストを取得する

次の例では、すべてのエンドポイントアトリビュートのリストを取得できます。

GET /v2/endpoints/{endpointId}?expand=all HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

すべてのアトリビュートとspeaker機能のリストを取得する

次の例では、すべてのエンドポイントアトリビュートとspeaker機能のリストを取得できます。

GET /v2/endpoints/{endpointId}?expand=all&expand=feature:speaker HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエストのクエリパラメーター

フィールド 説明 型 必須
expand 応答に含めるアトリビュート（またはアトリビュートのセット）。現在サポートされている値：all、feature:brightness、feature:color、feature:colorTemperature、feature:speaker、feature:temperatureSensor、feature:thermostat、feature:power、feature:connectivity。
注： expandには複数の値を指定できます。例：expand=all&expand=feature.connectivity		 文字列 ✕

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文のパラメーター

フィールド 説明 型 必須
id エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯
friendlyName NameValueオブジェクト形式の、エンドポイントのフレンドリー名。 オブジェクト ◯
manufacturer NameValueオブジェクト形式の、エンドポイントのメーカー。 オブジェクト ◯
model NameValueオブジェクト形式の、エンドポイントのモデル。 オブジェクト ◯
serialNumber NameValueオブジェクト形式の、エンドポイントのシリアル番号。 オブジェクト ◯
softwareVersion NameValueオブジェクト形式の、エンドポイントのソフトウェアのバージョン。 オブジェクト ◯
connections Connectionオブジェクトのリストの形式で表された、エンドポイントがインターネットおよびスマートホームハブへの接続に使用できる方法。エンドポイントと関連付けられている接続がない場合、このフィールドは空になります。 リスト ✕
creationTime エンドポイントのリソースが初めて作成された日時。 ISO 8601形式の日付 ✕
features このエンドポイントのFeatureオブジェクトのリスト。 リスト ✕
associatedUnits エンドポイントが関連付けられているユニットを表すUnitオブジェクトのリスト。リクエストでexpand=allが指定されている場合にのみ返されます。エンドポイントに関連付けられているユニットがない場合、このリストは空になります。 リスト ✕
displayCategories displayCategoriesオブジェクト。    
operations サポートされている操作を表すOperationオブジェクトのリスト。 リスト ✕

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラーのエラータイプ。リクエストが有効で、サービスがリクエストの実行に失敗した場合にのみ存在します。このフィールドはビジネスロジックで使用できます。 文字列 ✕
message エラーのエラーメッセージです。
注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。		 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 Success The request succeeded.
400 Bad Request リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized 認証に失敗しました。
404 Not Found パスにエンドポイントが存在しないか、エンドポイントIDが無効です。
429 Too Many Requests リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行します。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は500以外の応答を受信するまで256秒ごとに再試行します。
503 Service Unavailable サービスが一時的に使用できません。

エンドポイントとユニットの関連付けを管理する

associatedUnitsを更新する

PUT /v2/endpoints/{endpointId}/associatedUnitsを呼び出すと、エンドポイントに関連付けられたユニットのリストを更新できます。現時点では、エンドポイントと関連付けることができるユニットは一度に1つのみです。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/associatedUnits HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

[
  {
    "id": "amzn1.alexa.unit.did.{id}"
  }
]

デフォルトのユニットIDワイルドカードを使用したリクエスト本文

[
  {
    "id": "~caller.defaultUnitId"
  }
]

リクエスト本文のパラメーター

フィールド 説明 型 必須
Unitオブジェクトのリスト。 エンドポイントと関連付けるユニットのリスト。配列の各要素は、"amzn1.alexa.unit.did.{id}"という形式のユニットIDです。呼び出し元のデフォルトのユニットを指定するには、"~caller.defaultUnitId"というワイルドカードを使用します。現時点では、エンドポイントと関連付けることができるユニットは一度に1つのみです。
注： ユニットからエンドポイントを削除して、呼び出し元のAmazonビジネスアカウントに返すには、エンドポイントと呼び出し元のデフォルトのユニットを関連付けます。		 配列 ◯

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

{
    "endpoint": {
        "id": "amzn1.alexa.endpoint.ABC123...",
        "associatedUnits": [{
            "id": "amzn1.alexa.unit.did.ZXY987..."
        }]
    }
}

応答本文のパラメーター

フィールド 説明 型 必須
endpoint.id エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。注： エンドポイントとユニットの関連付けを変更すると、endpointIdが変更されることがあります。変更される場合、このフィールドに新しいendpointIdが格納されます。 文字列 ◯
associatedUnits エンドポイントが関連付けられているユニットを表すUnitオブジェクトのリスト。現時点では、エンドポイントと関連付けることができるユニットは一度に1つのみです。 リスト ◯
associatedUnits[].id ユニットID。"amzn1.alexa.unit.did.{id}"形式で指定します。 文字列 ◯

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラーのエラータイプ。リクエストが有効で、サービスがリクエストの実行に失敗した場合にのみ存在します。このフィールドはビジネスロジックで使用できます。 文字列 ✕
message エラーのエラーメッセージです。
注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。		 文字列 ✕

HTTP応答コード

ステータスコード 型 メッセージ 説明
200 OK The request succeeded.  
400 NO_SUCH_UNIT No such unit 本文で指定されたユニットが存在しません。
400 TOO_MANY_UNIT_ASSOCIATIONS The request exceeds the maximum number of unit IDs. リクエストはユニットIDの最大数を超過しています。指定するユニットIDの数を減らしてみてください。
400 ENDPOINT_UNREACHABLE The endpoint is unreachable. エンドポイントがオフラインです。デバイスに到達できないため、associatedUnitsを変更できません。
400 ENDPOINT_NOT_SUPPORTED Modifying associatedUnits is not supported for this endpoint. このデバイスタイプではassociatedUnitsの変更はサポートされていません。
400 TOO_FEW_UNIT_ASSOCIATIONS The request specifies too few unit IDs. 少なくとも1つのユニットIDを指定する必要があります。
401 UNAUTHORIZED Invalid or missing access token LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN Forbidden クライアントはリソースのリストを取得できますが、クライアントにはリソースの名前を変更する権限はありません。
404 NO_SUCH_ENDPOINT Endpoint not found パスにエンドポイントが存在しないか、クライアントにリソースのリストを取得する権限がありません。
429 TOO_MANY_REQUESTS Too Many Requests リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行します。
500 INTERNAL_SERVER_ERROR Internal Service Error サービスエラーが発生しました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は500以外の応答を受信するまで256秒ごとに再試行します。
503 SERVICE_UNAVAILABLE Service Unavailable サービスを一時的に利用できず、リクエストを処理できません。

エンドポイントのステータスを照会する

associatedUnitsを更新するAPIを呼び出して、コード200を受け取ると、クラウド側でエンドポイントとユニットを関連付ける処理が完了します。ただし、エンドポイント側でエンドポイントとユニットの関連付けを完了するには、物理的なエンドポイントで自動的な再起動が完了する必要があります。エンドポイントは自動的に再起動されるため、必要な作業はありません。

エンドポイントの再起動が正常に行われたことを確認するには、エンドポイントの接続ステータスをポーリングします。ポーリングの間隔は2分以上にすることをお勧めします。

このAPIでendpointIdが返された場合、エンドポイントは正常に再起動され、ネットワークに再接続されています。

リクエストの例

GET /v2/endpoints?associatedUnits.id=amzn1.alexa.unit.did.foo&connections.macAddress=00:11:22:AA:BB:33:44:55&features[name:connectivity].properties[name:reachability].value.value=OK HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

connectivity機能を管理する

features/connectivityを取得する

GET /v2/endpoints/{endpointId}/features/connectivityを呼び出すと、エンドポイントの接続に関連する状態とアトリビュートを取得できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/features/connectivity  HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエスト本文

なし。

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

{
    "properties": [
        {
            "name": "reachability",
            "type": "RETRIEVABLE",
            "value": {
                "value": "OK"
            },
            "timeOfSample": "2020-07-20T00:00:00Z"
        }
    ]
}

応答本文のパラメーター

フィールド 説明 型 必須
name プロパティの名前。この場合は"reachability"です。 文字列 ◯
value エンドポイントに到達可能な場合は"OK"、そうでない場合は"UNREACHABLE"です。 文字列 ✕
timeOfSample プロパティ値が取得された日時です。 日付 ✕
error このフィールドが存在する場合、プロパティ値の取得中にエラーが発生したことを示しています。 オブジェクト ✕

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。
注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。		 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
400 Bad Request リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden アクセストークンは有効ですが、必要なLWAスコープの権限をユーザーが持っていません。
429 Too many requests リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行します。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は500以外の応答を受信するまで256秒ごとに再試行します。
503 Service Unavailable サービスが一時的に使用できません。

Wi-Fiの設定を管理する

AlexaエンドポイントのWi-Fiの設定を管理し、状態を追跡します。これらのリクエストを使用するには、"credential_locker::wifi_management"および"alexa::enterprise:management"のスコープを持つLWAトークンが必要です。

saveWifiConfigurationsを実行する

POST /credentiallocker/v2/saveWifiConfigurationsを呼び出すと、エンドポイントで今後使用できるようにWi-Fiの設定を保存できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、カナダ

米国、カナダ

米国、カナダ

米国

リクエストの形式

POST /credentiallocker/v2/saveWifiConfigurations HTTP/1.1
Host: credential-locker-service.amazon.com
x-amz-access-token: {LWA Token}
Content-Type: application/json
Authorization: Bearer {LWA Token}

リクエスト本文の形式

{
    "wifiConfigurations": [{
        "credentialConfiguration": {
            "privateSharedKey": "\"wifi-password\""
        },
        "ssid": "\"wifi-ssid\"",
        "keyManagement": "WPAPSK"
    }]
}

リクエスト本文のパラメーター

フィールド 説明 型 必須

credentialConfiguration.
privateSharedKey

プライベート共有キー。二重引用符で囲む必要があります。

文字列

◯

ssid

Wi-Fi設定のネットワーク名。二重引用符で囲む必要があります。

文字列

◯

keyManagement

Wi-Fi設定のセキュリティタイプ。有効な値：オープンネットワークの場合はNONE、パスワードが設定されたWi-Fi SSIDの場合はWPAPSK。

文字列

◯

HTTP応答コード

ステータスコード タイプの説明  
200 OK Wi-Fiの設定が正常に保存されました。
400 BAD_REQUEST リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 UNAUTHORIZED LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN ユーザーがこの操作の実行を許可されていません。
500 INTERNAL_SERVER_ERROR サービスエラーが発生しました。

addOrUpdateWifiConfigurationsを実行する

POST /v2/endpoints/endpointId/features/connectivity/addOrUpdateWifiConfigurationsを呼び出すと、保存されているWi-Fi設定とエンドポイントを関連付けることができます。エンドポイントごとに最大32のWi-Fi設定を関連付けることができます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、カナダ

米国、カナダ

米国、カナダ

米国

リクエストの形式

POST /v2/endpoints/{endpointId}/features/connectivity/addOrUpdateWifiConfigurations HTTP/1.1
Host: api.amazonalexa.com
Authorization: Bearer {LWA Token}
Content-Type: application/json

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId すべてのエンドポイントを取得する呼び出しで返されたエンドポイントID。 文字列 ◯

リクエスト本文の形式

{
    "payload": {
        "wifiConfigurations": [{
            "ssid": "\"wifi-ssid\"",
            "keyManagement": "WPAPSK"
        }]
    }
}

リクエスト本文のパラメーター

フィールド 説明 型 必須

ssid

Wi-Fi設定のネットワーク名。二重引用符で囲む必要があります。saveWifiConfigurationsを実行する呼び出しと同じ値を使用する必要があります。

文字列

◯

keyManagement

Wi-Fi設定のセキュリティタイプ。saveWifiConfigurationsを実行する呼び出しと同じ値を使用する必要があります。

文字列

◯

応答本文の形式

{
     "submittedOperationId": "{operationId}"
}

応答本文のパラメーター

フィールド 説明 型 必須
submittedOperationId 操作のステータスを取得するために使用する識別子 文字列 ◯

HTTP応答コード

ステータスコード タイプの説明  
202 OK Wi-Fiのインストール操作が正常に実行され、応答の本文でステータスを追跡するためのoperationIdが返されました。
400 BAD_REQUEST リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 UNAUTHORIZED LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN ユーザーがこの操作の実行を許可されていません。
404 NOT_FOUND デバイスエンドポイントが見つからなかったか、指定されたWi-Fi設定が見つかりませんでした。
500 INTERNAL_SERVER_ERROR サービスエラーが発生しました。

Wi-Fiのインストールステータスを取得する

GET /v2/endpoints/endpointId/features/connectivity/addOrUpdateWifiConfigurations/submittedOperations/{operationId}を呼び出すと、addOrUpdateWifiConfigurations操作のステータスを取得できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、カナダ

米国、カナダ

米国、カナダ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/features/connectivity/addOrUpdateWifiConfigurations/submittedOperations/{operationId} HTTP/1.1
Host: api.amazonalexa.com
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントのID。POST addOrUpdateWiFiConfigurationsの呼び出しと同じIDを使用する必要があります。 文字列 ◯
operationId 操作のID。POST addOrUpdateWifiConfigurationsの呼び出しで返されたsubmittedOperationIdの値を使用する必要があります。 文字列 ◯

応答本文の例

{
     "status": "TIMEOUT"
}

応答本文のパラメーター

フィールド 説明 型 必須
status Statusオブジェクト形式の、指定されたaddOrUpdateWifiConfigurations操作のステータス。 オブジェクト ◯

Statusオブジェクトのスキーマ

フィールド 説明 型 必須

status

ステータスの値。有効な値は次のとおりです。
SUCCESS： Wi-Fi設定がデバイス上に正常にインストールされました。これでは、指定されたWi-Fi設定のデバイスの接続ステータスに関する情報は得られません。
FAILURE： デバイスへのメッセージの配信またはデバイスへのインストールの際にエラーが発生しました。内部エラーの詳細情報は提供されません。操作を再試行してください。
TIMEOUT： 操作がタイムアウトしました。デバイスがオフラインになっているか、応答を返せませんでした。実際のインストールステータスは不明です。操作を再試行してください。
IN_PROGRESS： 操作がまだ進行中です。

文字列

◯

HTTP応答コード

ステータスコード タイプの説明  
200 OK 操作によりステータスの値が正常に返されました。
300 RESOURCE_SPLIT エンドポイントIDが変更されましたが、使用されるリソースは変わっていません。応答の本文には新しいエンドポイントIDのURI参照が含まれます。例：/v2/endpoints/{newId}。
301 ENDPOINT_REMOVED エンドポイントIDが変更されましたが、使用されるリソースは変わっていません。応答の本文には新しいエンドポイントIDのURI参照が含まれます。例：/v2/endpoints/{newId}。
303 ENDPOINT_MERGED エンドポイントがもう1つのエンドポイントと統合され、使用されるリソースが変わりました。応答の本文には新しいエンドポイントIDのURI参照が含まれます。例：/v2/endpoints/{newId}。
400 BAD_REQUEST リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 UNAUTHORIZED LWAトークンの有効期限が切れました。
403 FORBIDDEN ユーザーが、指定されたエンドポイントに対して操作を実行することが許可されていません。
404 NOT_FOUND 指定されたendpointIdまたはaddOrUpdateWifiConfigurationsリクエストが存在しないか、リクエストのステータスが使用できなくなっています。
500 INTERNAL_SERVER_ERROR サービスエラーが発生しました。
503 Service Unavailable サービスが一時的に使用できません。

スマートホーム機能を管理する

features/colorを取得する

GET /v2/endpoints/{endpointId}/features/colorを呼び出すと、指定されたエンドポイントの色のプロパティと使用可能な操作を取得できます。色のプロパティの詳細については、機能のプロパティのスキーマを参照してください。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/features/color HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエスト本文

なし。

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

成功応答のヘッダー

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

{
   "properties": [
      {
         "name": "color",
         "type": "RETRIEVABLE",
         "value": {
            "hue": 20,
            "saturation": 0.5,
            "brightness": 0.7
         },
         "timeOfSample": "1970-01-01T00:00:00Z"
      }
   ],
   "operations": [
      {
         "name": "setColor",
         "path": "/v2/endpoints/{id}/features/color/setColor"
      }
   ]
}

部分的な成功応答本文の例

colorプロパティの取得中にエラーが発生した場合に返される応答の例を次に示します。

{
    "properties": [
        {
            "name": "color",
            "type": "ERROR",
            "error": {
                "type": "",
                "message": ""
            }
        }
    ],
    "operations": [
        {
            "name": "setColor",
            "path": "/v2/endpoints/{id}/features/color/setColor"
        }
    ]
}

応答本文のパラメーター

フィールド 説明 型 必須
properties 色のプロパティのリスト。現在、サポートされているのはcolorのみです。それぞれのPropertyオブジェクトはポリモーフィズム型です。リストの内容は、データを表示する権限がクライアントにあるかどうかに左右されます。 Propertyオブジェクトのリスト ◯（ただし、空の場合もあります）
operations 指定されたエンドポイントで使用可能な色の操作を定義するオブジェクトのリスト。 Operationオブジェクトのリスト ◯

Propertyオブジェクトのスキーマ

フィールド 説明 型 必須
name プロパティの名前。現時点でサポートされる値は、"color"のみです。 文字列 ◯
type Propertyオブジェクトのタイプ。サポートされている値は次の3つです。
RETRIEVABLE - Alexaがプロパティの値を取得できます。
NOT_RETRIEVABLE - プロパティで取得がサポートされていません。再試行しても成功しません。
ERROR - エラーにより、Alexaがプロパティの値を取得できません。再試行すると成功する可能性があります。		 文字列 ◯
value 現在の色。詳細については、機能のプロパティのスキーマを参照してください。 文字列 ✕
timeOfSample プロパティ値が取得された日時です。 日付 ✕
error このフィールドが存在する場合、プロパティ値の取得中にエラーが発生したことを示しています。 オブジェクト ✕

エラー応答

HTTP/1.1 {ErrorCode}

{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラーオブジェクトのスキーマ

フィールド 説明 型 必須
type プロパティの取得時に発生したエラーのタイプ。例：ENDPOINT_UNREACHABLE、ENDPOINT_BUSY。有効なエラータイプについては、エラータイプの値を参照してください。 文字列 ◯
message エラーのエラーメッセージです。
注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。		 文字列 ✕

HTTP応答コード

ステータスコード 型 メッセージ 説明
200 OK The request succeeded.  
400 BAD_REQUEST Bad Request 次の理由により、リクエストが無効です：{詳細な理由}。
401 UNAUTHORIZED Authentication Failure LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN Forbidden ユーザーがこの操作の実行を許可されていません。
404 NOT_FOUND Not Found パスでエンドポイントが見つかりませんでした。
指定された機能または操作はエンドポイントで使用できません。
429 TOO_MANY_REQUESTS Too Many Requests リクエストが制限されました。
500 INTERNAL_SERVER_ERROR Internal Service Error サービスエラーが発生しました。
503 ENDPOINT_UNREACHABLE Service Unavailable エンドポイントに到達できません。

features/colorを設定する

POST /v2/endpoints/{endpointId}/features/color/setColorを呼び出すと、指定されたエンドポイントの色のプロパティを設定できます。色のプロパティの詳細については、機能のプロパティのスキーマを参照してください。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

POST /v2/endpoints/{endpointId}/features/color/{operation} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯
operation 実行する操作：setColor。 文字列 ◯

setColorのリクエスト本文の例

{
    "payload": {
        "color": {
            "hue": 20,
            "saturation": 0.75,
            "brightness": 0.34
        }
    }
}

setColorのリクエスト本文のパラメーター

フィールド 説明 型 必須

payload

ペイロードラッパーオブジェクト

オブジェクト

◯

payload.color

colorオブジェクト。詳細については、機能のプロパティのスキーマを参照してください。

オブジェクト

◯

payload.color.hue

色相の値

Double

◯

payload.color.saturation

彩度の値

Double

◯

payload.color.brightness

輝度の値

Double

◯

成功応答のヘッダー

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

成功応答本文

操作が完全に成功している場合、応答本文はありません。

部分的な成功応答の例

HTTP/1.1 503 Service Unavailableの応答は、リクエストは正常に送信されたものの、エンドポイントを報告するエンティティからAlexaがエラー応答を受け取ったことを示します。エンドポイントのエラーの例：エンドポイントがオフラインになっている、エンドポイントのバッテリー残量が少なすぎる、など。

HTTP/1.1 503 Service Unavailable

{
    "type": "",
    "message": ""
}

エラー応答

HTTP/1.1 {ErrorCode}

{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラーオブジェクトのスキーマ

フィールド 説明 型 必須
type 発生したエラーのタイプ。例：ENDPOINT_UNREACHABLE、ENDPOINT_BUSY。リクエストが有効で、リクエストの正常な実行に失敗した場合にのみ存在します。有効なエラータイプについては、エラータイプの値を参照してください。 文字列 ✕
message エラーのエラーメッセージです。
注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。		 文字列 ✕

HTTP応答コード

ステータスコード 型 メッセージ 説明
200 OK The request succeeded.  
400 BAD_REQUEST Bad Request 次の理由により、リクエストが無効です：{詳細な理由}。
401 UNAUTHORIZED Authentication Failure LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN Forbidden ユーザーがこの操作の実行を許可されていません。
404 NOT_FOUND Not Found パスでエンドポイントが見つかりませんでした。
指定された機能または操作はエンドポイントで使用できません。
429 TOO_MANY_REQUESTS Too Many Requests リクエストが制限されました。
500 INTERNAL_SERVER_ERROR Internal Service Error サービスエラーが発生しました。
503 ENDPOINT_UNREACHABLE Service Unavailable エンドポイントに到達できません。

features/brightnessを取得する

GET /v2/endpoints/{endpointId}/features/brightnessを呼び出すと、指定されたエンドポイントの輝度の設定と使用可能な操作を取得できます。輝度のプロパティの詳細については、機能のプロパティのスキーマを参照してください。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/features/brightness HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエスト本文

なし。

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

成功応答のヘッダー

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

{
   "properties": [
      {
         "name": "brightness",
         "type": "RETRIEVABLE",
         "value": {
            "value": 50
         },
         "timeOfSample": "1970-01-01T00:00:00Z"
      }
   ],
   "operations": [
       {
          "name": "setBrightness",
          "path": "/v2/endpoints/{id}/features/brightness/setBrightness"
       },
       {
          "name": "adjustBrightness",
          "path": "/v2/endpoints/{id}/features/brightness/adjustBrightness"
       }
   ]
}

部分的な成功応答本文の例

brightnessプロパティの取得中にエラーが発生した場合に返される応答の例を次に示します。

{
    "properties": [
        {
            "name": "brightness",
            "type": "ERROR",
            "error": {
                "type": "",
                "message": ""
            }
        }
    ],
    "operations": [
        {
            "name": "setBrightness",
            "path": "/v2/endpoints/{id}/features/brightness/setBrightness"
        },
        {
            "name": "adjustBrightness",
            "path": "/v2/endpoints/{id}/features/brightness/adjustBrightness"
        }
    ]
}

応答本文のパラメーター

フィールド 説明 型 必須
properties 輝度のプロパティのリスト。現在、サポートされているのはbrightnessのみです。それぞれのPropertyオブジェクトはポリモーフィズム型です。リストの内容は、データを表示する権限がクライアントにあるかどうかに左右されます。 Propertyオブジェクトのリスト ◯（ただし、空の場合もあります）
operations 指定されたエンドポイントで使用可能な輝度の操作を定義するオブジェクトのリスト。 Operationオブジェクトのリスト ◯

Propertyオブジェクトのスキーマ

フィールド 説明 型 必須
name プロパティの名前。現時点でサポートされる値は、brightnessのみです。 文字列 ◯
type Propertyオブジェクトのタイプ。サポートされている値は次の3つです。
RETRIEVABLE - Alexaがプロパティの値を取得できます。
NOT_RETRIEVABLE - プロパティで取得がサポートされていません。再試行しても成功しません。
ERROR - エラーにより、Alexaがプロパティの値を取得できません。再試行すると成功する可能性があります。		 文字列 ◯
value 現在の輝度のレベル。有効な値は0～100です（両端の値を含みます）。詳細については、機能のプロパティのスキーマを参照してください。 文字列 ✕
timeOfSample プロパティ値が取得された日時です。 日付 ✕
error このフィールドが存在する場合、プロパティ値の取得中にエラーが発生したことを示しています。 オブジェクト ✕

エラー応答

HTTP/1.1 {ErrorCode}

{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラーオブジェクトのスキーマ

フィールド 説明 型 必須
type プロパティの取得時に発生したエラーのタイプ。例：ENDPOINT_UNREACHABLE、ENDPOINT_BUSY。有効なエラータイプについては、エラータイプの値を参照してください。 文字列 ◯
message エラーのエラーメッセージです。
注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。		 文字列 ✕

HTTP応答コード

ステータスコード 型 メッセージ 説明
200 OK The request succeeded.  
400 BAD_REQUEST Bad Request 次の理由により、リクエストが無効です：{詳細な理由}。
401 UNAUTHORIZED Authentication Failure LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN Forbidden ユーザーがこの操作の実行を許可されていません。
404 NOT_FOUND Not Found パスでエンドポイントが見つかりませんでした。
指定された機能または操作はエンドポイントで使用できません。
429 TOO_MANY_REQUESTS Too Many Requests リクエストが制限されました。
500 INTERNAL_SERVER_ERROR Internal Service Error サービスエラーが発生しました。
503 ENDPOINT_UNREACHABLE Service Unavailable エンドポイントに到達できません。

features/brightnessを設定する

POST /v2/endpoints/{endpointId}/features/brightness/setBrightnessを呼び出すと、指定されたエンドポイントの輝度のレベルを設定できます。POST /v2/endpoints/{endpointId}/features/brightness/adjustBrightnessを呼び出すと、指定されたエンドポイントの輝度のレベルを指定された分だけ変更できます。

輝度のプロパティの詳細については、機能のプロパティのスキーマを参照してください。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

POST /v2/endpoints/{endpointId}/features/brightness/{operation} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯
operation 実行する操作：setBrightness。 文字列 ◯

setBrightnessのリクエスト本文の例

{
    "payload": {
        "brightness": 50
    }
}

setBrightnessのリクエスト本文のパラメーター

フィールド 説明 型 必須

payload

ペイロードラッパーオブジェクト

オブジェクト

◯

payload.brightness

輝度の値。有効な値は0～100です（両端の値を含みます）。詳細については、機能のプロパティのスキーマを参照してください。

整数

◯

adjustBrightnessのリクエスト本文の例

{
    "payload": {
        "brightnessDelta": 10
    }
}

adjustBrightnessのリクエスト本文のパラメーター

フィールド 説明 型 必須

payload

ペイロードラッパーオブジェクト

オブジェクト

◯

payload.brightnessDelta

輝度の差分の値。有効な値は-100～100です（両端の値を含みます）。詳細については、機能のプロパティのスキーマを参照してください。

整数

◯

成功応答のヘッダー

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

成功応答本文

操作が完全に成功している場合、応答本文はありません。

部分的な成功応答の例

HTTP/1.1 503 Service Unavailableの応答は、リクエストは正常に送信されたものの、エンドポイントを報告するエンティティからAlexaがエラー応答を受け取ったことを示します。エンドポイントのエラーの例：エンドポイントがオフラインになっている、エンドポイントのバッテリー残量が少なすぎる、など。

HTTP/1.1 503 Service Unavailable

{
    "type": "",
    "message": ""
}

エラー応答

HTTP/1.1 {ErrorCode}

{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラーオブジェクトのスキーマ

フィールド 説明 型 必須
type 発生したエラーのタイプ。例：ENDPOINT_UNREACHABLE、ENDPOINT_BUSY。リクエストが有効で、リクエストの正常な実行に失敗した場合にのみ存在します。有効なエラータイプについては、エラータイプの値を参照してください。 文字列 ✕
message エラーのエラーメッセージです。
注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。		 文字列 ✕

HTTP応答コード

ステータスコード 型 メッセージ 説明
200 OK The request succeeded.  
400 BAD_REQUEST Bad Request 次の理由により、リクエストが無効です：{詳細な理由}。
401 UNAUTHORIZED Authentication Failure LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN Forbidden ユーザーがこの操作の実行を許可されていません。
404 NOT_FOUND Not Found パスでエンドポイントが見つかりませんでした。
指定された機能または操作はエンドポイントで使用できません。
429 TOO_MANY_REQUESTS Too Many Requests リクエストが制限されました。
500 INTERNAL_SERVER_ERROR Internal Service Error サービスエラーが発生しました。
503 ENDPOINT_UNREACHABLE Service Unavailable エンドポイントに到達できません。

features/colorTemperatureを取得する

GET /v2/endpoints/{endpointId}/features/colorTemperatureを呼び出すと、指定されたエンドポイントの温度のプロパティと使用可能な操作を取得できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/features/colorTemperature HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエスト本文

なし。

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

成功応答のヘッダー

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

{
   "properties": [
      {
         "name": "colorTemperatureInKelvin",
         "type": "RETRIEVABLE",
         "value": {
            "value": "2700"
         },
         "timeOfSample": "1970-01-01T00:00:00Z"
      }
   ],
   "operations": [
      {
          "name": "setColorTemperature",
          "path": "/v2/endpoints/{id}/features/colorTemperature/setColorTemperature"
      },
      {
         "name": "increaseColorTemperature",
         "path": "/v2/endpoints/{id}/features/colorTemperature/increaseColorTemperature"
      },
      {
         "name": "decreaseColorTemperature",
         "path": "/v2/endpoints/{id}/features/colorTemperature/decreaseColorTemperature"
      }
   ]
}

部分的な成功応答本文の例

colorTemperatureプロパティの取得中にエラーが発生した場合に返される応答の例を次に示します。

{
    "properties": [
        {
            "name": "colorTemperatureInKelvin",
            "type": "ERROR",
            "error": {
                "type": "",
                "message": ""
            }
        }
    ],
    "operations": [
        {
            "name": "setColorTemperature",
            "path": "/v2/endpoints/{id}/features/colorTemperature/setColorTemperature"
        },
        {
           "name": "increaseColorTemperature",
           "path": "/v2/endpoints/{id}/features/colorTemperature/increaseColorTemperature"
        },
        {
          "name": "decreaseColorTemperature",
          "path": "/v2/endpoints/{id}/features/colorTemperature/decreaseColorTemperature"
        }
    ]
}

応答本文のパラメーター

フィールド 説明 型 必須
properties 色温度のプロパティのリスト。現在サポートされているのはcolorTemperatureInKelvinのみです。それぞれのPropertyオブジェクトはポリモーフィズム型です。リストの内容は、データを表示する権限がクライアントにあるかどうかに左右されます。 Propertyオブジェクトのリスト ◯（ただし、空の場合もあります）
operations 指定されたエンドポイントで使用可能な色温度の操作を定義するオブジェクトのリスト。 Operationオブジェクトのリスト ◯（ただし、空の場合もあります）

Propertyオブジェクトのスキーマ

フィールド 説明 型 必須
name プロパティの名前。現在サポートされている値は、"colorTemperatureInKelvin"のみです。 文字列 ◯
type Propertyオブジェクトのタイプ。サポートされている値は次の3つです。
RETRIEVABLE - Alexaがプロパティの値を取得できます。
NOT_RETRIEVABLE - プロパティで取得がサポートされていません。再試行しても成功しません。
ERROR - エラーにより、Alexaがプロパティの値を取得できません。再試行すると成功する可能性があります。		 文字列 ◯
value 現在の色温度のケルビン値。価の範囲は1000～10000です（両端の値を含みます）。 整数 ✕
timeOfSample プロパティ値が取得された日時です。 日付 ✕
error このフィールドが存在する場合、プロパティ値の取得中にエラーが発生したことを示しています。 オブジェクト ✕

エラー応答

HTTP/1.1 {ErrorCode}

{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラーオブジェクトのスキーマ

フィールド 説明 型 必須
type プロパティの取得時に発生したエラーのタイプ。例：ENDPOINT_UNREACHABLE、ENDPOINT_BUSY。有効なエラータイプについては、エラータイプの値を参照してください。 文字列 ◯
message エラーのエラーメッセージです。
注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。		 文字列 ✕

HTTP応答コード

ステータスコード 型 メッセージ 説明
200 OK The request succeeded.  
400 BAD_REQUEST Bad Request 次の理由により、リクエストが無効です：{詳細な理由}。
401 UNAUTHORIZED Authentication Failure LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN Forbidden ユーザーがこの操作の実行を許可されていません。
404 NOT_FOUND Not Found パスでエンドポイントが見つかりませんでした。
指定された機能または操作はエンドポイントで使用できません。
429 TOO_MANY_REQUESTS Too Many Requests リクエストが制限されました。
500 INTERNAL_SERVER_ERROR Internal Service Error サービスエラーが発生しました。
503 ENDPOINT_UNREACHABLE Service Unavailable エンドポイントに到達できません。

features/colorTemperatureを設定する

POST /v2/endpoints/{endpointId}/features/colorTemperature/setColorTemperatureを呼び出すと、指定されたエンドポイントの色温度を設定できます。

POST /v2/endpoints/{endpointId}/features/colorTemperature/increaseColorTemperatureを呼び出すと、指定されたエンドポイントの色温度の値を大きくすることができます。この呼び出しでは色温度が調整されますが、変化量の値は指定できません。変化量はサービスの実装またはメーカーしだいとなります。この呼び出しには、リクエスト本文はありません。

POST /v2/endpoints/{endpointId}/features/colorTemperature/decreaseColorTemperatureを呼び出すと、指定されたエンドポイントの色温度の値を小さくすることができます。この呼び出しでは色温度が調整されますが、変化量の値は指定できません。変化量はサービスの実装またはメーカーしだいとなります。この呼び出しには、リクエスト本文はありません。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

POST /v2/endpoints/{endpointId}/features/colorTemperature/{operation} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯
operation 実行する操作：setColorTemperature、increaseColorTemperature、またはdecreaseColorTemperature。 文字列 ◯

setColorTemperatureのリクエスト本文の例

{
    "payload": {
        "colorTemperatureInKelvin": 2700
    }
}

setColorTemperatureのリクエスト本文のパラメーター

フィールド 説明 型 必須

payload

ペイロードラッパーオブジェクト

オブジェクト

◯

payload.colorTemperatureInKelvin

色温度の値。1000～10000（両端の値を含みます）。

整数

◯

成功応答のヘッダー

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

成功応答本文

操作が完全に成功している場合、応答本文はありません。

部分的な成功応答の例

HTTP/1.1 503 Service Unavailableの応答は、リクエストは正常に送信されたものの、エンドポイントを報告するエンティティからAlexaがエラー応答を受け取ったことを示します。エンドポイントのエラーの例：エンドポイントがオフラインになっている、エンドポイントのバッテリー残量が少なすぎる、など。

HTTP/1.1 503 Service Unavailable

{
    "type": "",
    "message": ""
}

エラー応答

HTTP/1.1 {ErrorCode}

{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラーオブジェクトのスキーマ

フィールド 説明 型 必須
type 発生したエラーのタイプ。例：ENDPOINT_UNREACHABLE、ENDPOINT_BUSY。リクエストが有効で、リクエストの正常な実行に失敗した場合にのみ存在します。有効なエラータイプについては、エラータイプの値を参照してください。 文字列 ✕
message エラーのエラーメッセージです。
注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。		 文字列 ✕

HTTP応答コード

ステータスコード 型 メッセージ 説明
200 OK The request succeeded.  
400 BAD_REQUEST Bad Request 次の理由により、リクエストが無効です：{詳細な理由}。
401 UNAUTHORIZED Authentication Failure LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN Forbidden ユーザーがこの操作の実行を許可されていません。
404 NOT_FOUND Not Found パスでエンドポイントが見つかりませんでした。
指定された機能または操作はエンドポイントで使用できません。
429 TOO_MANY_REQUESTS Too Many Requests リクエストが制限されました。
500 INTERNAL_SERVER_ERROR Internal Service Error サービスエラーが発生しました。
503 ENDPOINT_UNREACHABLE Service Unavailable エンドポイントに到達できません。

features/powerを取得する

GET /v2/endpoints/{endpointId}/features/powerを呼び出すと、指定されたエンドポイントの電源機能のプロパティおよび対応する値を取得できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/features/power HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエスト本文

なし。

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

{
   "properties": [
      {
         "name": "powerState",
         "type": "RETRIEVABLE",
         "value": {
             "value": "ON"
         },
         "timeOfSample": "1970-01-01T00:00:00Z"
      }
   ],
   "operations": [
      {
         "name": "turnOn",
         "path": "/v2/endpoints/{endpointID}/features/power/turnOn"
      },
      {
         "name": "turnOff",
         "path": "/v2/endpoints/{endpointID}/features/power/turnOff"
      }
   ]
}

部分的な成功応答の例

powerStateプロパティの取得中にエラーが発生した場合に返される応答の例を次に示します。

{
    "properties": [
        {
            "name": "powerState",
            "type": "ERROR",
            "error": {
                "type": "{ErrorType}",
                "message": "{ErrorMessage}"
            }
        }
    ],
    "operations": [
        {
            "name": "turnOn",
            "path": "/v2/endpoints/{id}/features/power/turnOn"
        },
        {
            "name": "turnOff",
            "path": "/v2/endpoints/{id}/features/power/turnOff"
        }
    ]
}

応答本文のパラメーター

フィールド 説明 型 必須
properties 電力状態などの、電源機能のプロパティのリストです。それぞれのPropertyオブジェクトはポリモーフィズム型です。たとえば、powerStateプロパティオブジェクトは、サンプリング時のエンドポイントの電力状態を表します。 Propertyオブジェクトのリスト ◯
operations 指定されたエンドポイントで使用可能な電源機能の操作を定義するオブジェクトのリスト。 Operationオブジェクトのリスト ◯

Propertyオブジェクトのスキーマ

フィールド 説明 型 必須
name プロパティの名前。現時点でサポートされる値は、"powerState"のみです。 文字列 ◯
type Propertyオブジェクトのタイプ。サポートされている値は次の3つです。
RETRIEVABLE - Alexaがプロパティの値を取得できます。
NOT_RETRIEVABLE - プロパティで取得がサポートされていません。再試行しても成功しません。
ERROR - エラーにより、Alexaがプロパティの値を取得できません。再試行すると成功する可能性があります。		 文字列 ◯
value 現在の電力状態： ONまたはOFF。 文字列 ✕
timeOfSample プロパティ値が取得された日時です。 日付 ✕
error このフィールドが存在する場合、プロパティ値の取得中にエラーが発生したことを示しています。 オブジェクト ✕

エラーオブジェクトのスキーマ

フィールド 説明 型 必須
type プロパティの取得中に発生したエラーのタイプ： "DEVICE_UNREACHABLE"または"INTERNAL_ERROR"。 文字列 ◯
message エラーのエラーメッセージです。
注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。		 文字列 ✕

Operationオブジェクトのスキーマ

フィールド 説明 型 必須
name 操作の名前。電源機能の場合、これは"turnOn"または"turnOff"です。 文字列 ◯
path 機能のプロパティの設定に使用できるフルパス。 文字列 ◯

HTTP応答コード

ステータスコード 型 メッセージ 説明
200 OK The request succeeded.  
400 BAD_REQUEST Bad Request 次の理由により、リクエストが無効です：{詳細な理由}。
401 UNAUTHORIZED Authentication Failure LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN Forbidden ユーザーがこの操作の実行を許可されていません。
404 NOT_FOUND Not Found パスでエンドポイントが見つかりませんでした。
指定された機能または操作はエンドポイントで使用できません。
429 TOO_MANY_REQUESTS Too Many Requests リクエストが制限されました。
500 INTERNAL_SERVER_ERROR Internal Service Error サービスエラーが発生しました。
503 ENDPOINT_UNREACHABLE Service Unavailable エンドポイントに到達できません。

features/powerを設定する

POST /v2/endpoints/{endpointId}/features/power/turnOnを呼び出すと、エンドポイントの電源をオンにすることができます。

POST /v2/endpoints/{endpointId}/features/power/turnOffを呼び出すと、エンドポイントの電源をオフにすることができます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

POST /v2/endpoints/{endpointId}/features/power/{operation} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯
operation 実行する操作：turnOnまたはturnOff。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 型 メッセージ 説明
200 OK The request succeeded.  
400 BAD_REQUEST Bad Request 次の理由により、リクエストが無効です：{詳細な理由}。
401 UNAUTHORIZED Authentication Failure LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN Forbidden ユーザーがこの操作の実行を許可されていません。
404 NOT_FOUND Not Found パスでエンドポイントが見つかりませんでした。
指定された機能または操作はエンドポイントで使用できません。
429 TOO_MANY_REQUESTS Too Many Requests リクエストが制限されました。
500 INTERNAL_SERVER_ERROR Internal Service Error サービスエラーが発生しました。
503 ENDPOINT_UNREACHABLE Service Unavailable エンドポイントに到達できません。

features/temperatureSensorを取得する

GET /v2/endpoints/{endpointId}/features/temperatureSensorを呼び出すと、指定されたエンドポイントのtemperatureSensor機能のプロパティおよび対応する値を取得できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/features/temperatureSensor HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエスト本文

なし。

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

{
   "name": "temperatureSensor",
   "properties": [
      {
         "name": "temperature",
         "type": "RETRIEVABLE",
         "value": {
            "value": 68.0,
            "scale": "FAHRENHEIT"
         },
         "timeOfSample": "2021-03-04T17:46:42.48Z"
      },
   ]
}

サポートされているプロパティ値

フィールド 説明 型 必須
temperature.value センサーから報告された温度。 Temperatureオブジェクト ✕

Temperature

フィールド 説明 型
value 温度です。 Double
scale 温度の単位です。 温度単位文字列です。

温度値の例

{
    "value": {
        "value": 68.0,
        "scale": "FAHRENHEIT"
    }
}

温度単位

値 説明
CELSIUS 摂氏です。
FAHRENHEIT 華氏です。
KELVIN ケルビンです。

features/thermostatを取得する

GET /v2/endpoints/{endpointId}/features/thermostatを呼び出すと、指定したエンドポイントのサーモスタット機能のプロパティおよび対応する値を取得できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/features/thermostat HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエスト本文

なし。

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答の例（設定値が1つのサーモスタット）

{
   "name": "thermostat",
   "properties": [
      {
         "name": "thermostatMode",
         "type": "RETRIEVABLE",
         "value": {
            "value": "HEAT"
         },
         "timeOfSample": "2021-03-04T17:46:42.48Z"
      },
      {
         "name": "targetSetpoint",
         "type": "RETRIEVABLE",
         "value": {
            "value": 68.0,
            "scale": "FAHRENHEIT"
         },
         "timeOfSample": "2021-03-04T17:46:42.48Z"
      },
   ],
   "operations": [
      {
         "name": "setThermostatMode",
         "path": "/v2/endpoints/{endpointID}/features/thermostat/setThermostatMode"
      },
      {
         "name": "setTargetSetpoint",
         "path": "/v2/endpoints/{endpointID}/features/thermostat/setTargetSetpoint"
      },
      {
         "name": "adjustTargetSetpoint",
         "path": "/v2/endpoints/{endpointID}/features/thermostat/adjustTargetSetpoint"
      }
   ],
   "configuration": {
      "supportedModes": [
         "HEAT",
         "COOL",
         "AUTO"
      ]
   }
}

応答の例（設定値が2つのサーモスタット）

{
   "name": "thermostat",
   "properties": [
      {
         "name": "thermostatMode",
         "type": "RETRIEVABLE",
         "value": {
            "value": "HEAT"
         },
         "timeOfSample": "2021-03-04T17:46:42.48Z"
      },
      {
         "name": "lowerSetpoint",
         "type": "RETRIEVABLE",
         "value": {
            "value": 68.0,
            "scale": "FAHRENHEIT"
         },
         "timeOfSample": "2021-03-04T17:46:42.48Z"
      },
      {
         "name": "upperSetpoint",
         "type": "RETRIEVABLE",
         "value": {
            "value": 73.0,
            "scale": "FAHRENHEIT"
         },
         "timeOfSample": "2021-03-04T17:46:42.48Z"
      }
   ],
   "operations": [
      {
         "name": "setThermostatMode",
         "path": "/v2/endpoints/{endpointID}/features/thermostat/setThermostatMode"
      },
      {
         "name": "setTargetSetpoint",
         "path": "/v2/endpoints/{endpointID}/features/thermostat/setTargetSetpoint"
      }
   ],
   "configuration": {
      "supportedModes": [
         "HEAT",
         "COOL",
         "AUTO"
      ]
   }
}

サポートされているプロパティ値

フィールド 説明 型 必須
targetSetpoint.value 設定値が1つのサーモスタットの目標温度。 Temperatureオブジェクト ✕
lowerSetpoint.value 設定値が2つのサーモスタットの下限の設定値。 Temperatureオブジェクト ✕
upperSetpoint.value 設定値が2つのサーモスタットの上限の設定値。 Temperatureオブジェクト ✕
thermostatMode.value サーモスタットのモード。 ThermostatMode文字列 ✕

Temperature

フィールド 説明 型
value 温度です。 Double
scale 温度の単位です。 温度単位文字列です。

温度値の例

{
    "value": {
        "value": 68.0,
        "scale": "FAHRENHEIT"
    }
}

温度単位

値 説明
CELSIUS 摂氏です。
FAHRENHEIT 華氏です。
KELVIN ケルビンです。

ThermostatModeの値

値 説明
AUTO 現在の温度と設定温度に基づいた自動暖房および自動冷房モードです。
COOL 冷房モードです。
HEAT 暖房モードです。
ECO エコモードです。
OFF 暖房と冷房はオフで、デバイスの電源は入っている可能性があることを示します。

サポートされている設定

フィールド 説明 型 必須
supportedModes デバイスでサポートされているモードです。 ThermostatMode文字列の配列 ◯

機能の操作

サポートされている操作

フィールド 説明
adjustTargetSetpoint 設定値が1つのサーモスタットの目標設定値を、指定された値で調整します。
setTargetSetpoint サーモスタットを指定された設定値に設定します。
setThermostatMode サーモスタットのモードを設定します。

adjustTargetSetpoint

POST /v2/endpoints/{endpointId}/features/thermostat/adjustTargetSetpointを呼び出すと、設定値が1つのサーモスタットの目標設定値を、指定された値で調整できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

POST /v2/endpoints/{endpointId}/features/thermostat/adjustTargetSetpoint HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文のペイロード

フィールド 説明 型 必須
targetSetpointDelta サーモスタットの設定値をどれだけ調整するかの値。 Temperatureオブジェクト ◯

リクエストの例

POST
/v2/endpoints/amzn1.alexa.endpoint.abc123/features/thermostat/adjustTargetSetpoint HTTP/1.1
Host: api.amazonalexa.com
Authorization: Bearer 
{
   "payload": {
      "targetSetpointDelta": {
         "value": -2.0,
         "scale": "CELSIUS"
      }
   }
}

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 型 メッセージ 説明
200 OK The request succeeded.  
400 BAD_REQUEST Bad Request 次の理由により、リクエストが無効です：{詳細な理由}。
401 UNAUTHORIZED Authentication Failure LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN Forbidden ユーザーがこの操作の実行を許可されていません。
404 NOT_FOUND Not Found パスでエンドポイントが見つかりませんでした。
指定された機能または操作はエンドポイントで使用できません。
429 TOO_MANY_REQUESTS Too Many Requests リクエストが制限されました。
500 INTERNAL_SERVER_ERROR Internal Service Error サービスエラーが発生しました。
503 ENDPOINT_UNREACHABLE Service Unavailable エンドポイントに到達できません。

setTargetSetpoint

POST /v2/endpoints/{endpointId}/features/thermostat/setTargetSetpointを呼び出すと、サーモスタットに指定した設定値を設定できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

POST /v2/endpoints/{endpointId}/features/thermostat/setTargetSetpoint HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文のペイロード

フィールド 説明 型 必須
targetSetpoint 設定値が1つのサーモスタットの目標設定値。 Temperatureオブジェクト ◯（設定値が1つのサーモスタットの場合）
lowerSetpoint 設定値が2つのサーモスタットの下限の設定値。 Temperatureオブジェクト ◯（設定値が2つのサーモスタットの場合）
upperSetpoint 設定値が2つのサーモスタットの上限の設定値。 Temperatureオブジェクト ◯（設定値が2つのサーモスタットの場合）

リクエストの例（設定値が1つの場合）

POST
/v2/endpoints/amzn1.alexa.endpoint.abc123/features/thermostat/setTargetSetpoint HTTP/1.1
Host: api.amazonalexa.com
Authorization: Bearer 
{
   "payload": {
      "targetSetpoint": {
         "value": 21.0,
         "scale": "CELSIUS"
      }
   }
}

リクエストの例（設定値が2つの場合）

POST
/v2/endpoints/amzn1.alexa.endpoint.abc123/features/thermostat/setTargetSetpoint HTTP/1.1
Host: api.amazonalexa.com
Authorization: Bearer 
{
   "payload": {
      "lowerSetpoint": {
         "value": 68.0,
         "scale": "FAHRENHEIT"
      },
      "upperSetpoint": {
         "value": 72.0,
         "scale": "FAHRENHEIT"
      }
   }
}

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 型 メッセージ 説明
200 OK The request succeeded.  
400 BAD_REQUEST Bad Request 次の理由により、リクエストが無効です：{詳細な理由}。
401 UNAUTHORIZED Authentication Failure LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN Forbidden ユーザーがこの操作の実行を許可されていません。
404 NOT_FOUND Not Found パスでエンドポイントが見つかりませんでした。
指定された機能または操作はエンドポイントで使用できません。
429 TOO_MANY_REQUESTS Too Many Requests リクエストが制限されました。
500 INTERNAL_SERVER_ERROR Internal Service Error サービスエラーが発生しました。
503 ENDPOINT_UNREACHABLE Service Unavailable エンドポイントに到達できません。

setThermostatMode

POST /v2/endpoints/{endpointId}/features/thermostat/setThermostatModeを呼び出すと、サーモスタットのモードを設定できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

POST /v2/endpoints/{endpointId}/features/thermostat/setThermostatMode HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文のペイロード

フィールド 説明 型 必須
thermostatMode サーモスタットに設定するモード。 ThermostatMode文字列 ◯（設定値が1つのサーモスタットの場合）

リクエストの例（設定値が2つの場合）

POST
/v2/endpoints/amzn1.alexa.endpoint.abc123/features/thermostat/setTargetSetpoint HTTP/1.1
Host: api.amazonalexa.com
Authorization: Bearer 
{
   "payload": {
      "thermostatMode": "HEAT"
   }
}

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 型 メッセージ 説明
200 OK The request succeeded.  
400 BAD_REQUEST Bad Request 次の理由により、リクエストが無効です：{詳細な理由}。
401 UNAUTHORIZED Authentication Failure LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN Forbidden ユーザーがこの操作の実行を許可されていません。
404 NOT_FOUND Not Found パスでエンドポイントが見つかりませんでした。
指定された機能または操作はエンドポイントで使用できません。
429 TOO_MANY_REQUESTS Too Many Requests リクエストが制限されました。
500 INTERNAL_SERVER_ERROR Internal Service Error サービスエラーが発生しました。
503 ENDPOINT_UNREACHABLE Service Unavailable エンドポイントに到達できません。

speaker機能を管理する

features/speakerを取得する

GET /endpoints/{endpointID}/features/speakerを呼び出すと、指定されたエンドポイントのスピーカー機能のプロパティおよび対応する値を取得できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/features/speaker HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエスト本文

なし。

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

{
   "properties": [
      {
         "name": "volume",
         "type": "RETRIEVABLE",
         "value": {
             "value": 42
         },
         "timeOfSample": "1970-01-01T00:00:00Z"
      }
   ],
   "operations": [
      {
         "name": "setVolume",
         "path": "/v2/endpoints/{endpointID}/features/speaker/setVolume"
      },
      {
         "name": "adjustVolume",
         "path": "/v2/endpoints/{endpointID}/features/speaker/adjustVolume"
      }
   ]
}

部分的な成功応答の例

volumeプロパティの取得中にエラーが発生した場合に返される応答の例を次に示します。

{
    "properties": [
        {
            "name": "volume",
            "type": "RETRIEVABLE",
            "error": {
                "type": "{ErrorType}",
                "message": "{ErrorMessage}"
            }
        }
    ],
    "operations": [
        {
            "name": "setVolume",
            "path": "/v2/endpoints/<id>/features/speaker/setVolume"
        },
        {
            "name": "adjustVolume",
            "path": "/v2/endpoints/<id>/features/speaker/adjustVolume"
        }
    ]
}

応答本文のパラメーター

フィールド 説明 型 必須
properties 音量などの、スピーカー機能のプロパティのリスト。それぞれのPropertyオブジェクトはポリモーフィズム型です。たとえば、volumeプロパティオブジェクトは、サンプリング時のエンドポイントのスピーカーの状態を表します。 Propertyオブジェクトのリスト ◯
operations 指定されたエンドポイントで使用可能なスピーカー機能の操作を定義するオブジェクトのリスト。 Operationオブジェクトのリスト ◯

Propertyオブジェクトのスキーマ

フィールド 説明 型 必須
name プロパティの名前。現時点でサポートされる値は、"volume"のみです。 文字列 ◯
type Propertyオブジェクトのタイプ。サポートされている値は次の3つです。
RETRIEVABLE - Alexaがプロパティの値を取得できます。
NOT_RETRIEVABLE - プロパティで取得がサポートされていません。再試行しても成功しません。
ERROR - エラーにより、Alexaがプロパティの値を取得できません。再試行すると成功する可能性があります。		 文字列 ◯
value 「42」など、現在の音量。有効範囲は0～100です。 整数 ✕
timeOfSample プロパティ値が取得された日時です。 日付 ✕
error このフィールドが存在する場合、プロパティ値の取得中にエラーが発生したことを示しています。 オブジェクト ✕

エラーオブジェクトのスキーマ

フィールド 説明 型 必須
type プロパティの取得中に発生したエラーのタイプ： "DEVICE_UNREACHABLE"または"INTERNAL_ERROR"。 文字列 ◯
message プロパティの名前。例："volume"。 文字列 ◯

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
400 Bad Request リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden アクセストークンは有効ですが、必要なLWAスコープの権限をユーザーが持っていません。
404 Not found リクエストされた構成要素がクライアントについて検出されませんでした。
429 Too many requests サーバーがビジー状態であるため、リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。1秒後に再試行し、2回以上の再試行は行わないようにします。
503 Service Unavailable サービスが一時的に使用できません。

features/speakerを設定する

POST /v2/endpoints/{endpointId}/features/speaker/setVolumeを呼び出すと、指定されたエンドポイントのスピーカーの音量が指定された値に設定されます。

POST /v2/endpoints/{endpointId}/features/speaker/adjustVolumeを呼び出すと、指定されたエンドポイントのスピーカーの音量が指定された値で調整されます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

POST /v2/endpoints/{endpointID}/features/speaker/{operation} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯
operation 指定されたエンドポイントのスピーカー機能で公開されているDAAPI操作のいずれか1つ（setVolumeまたはadjustVolume）。 文字列 ◯

setVolumeのリクエスト本文の例

{
    "payload": {
        "volume": 42
    }
}

setVolumeのリクエスト本文のパラメーター

フィールド 説明 型 必須
volume エンドポイントのスピーカーの音量として設定する絶対的な音量。有効範囲は0～100です。 文字列 ◯

adjustVolumeのリクエスト本文の例

{
    "payload": {
        "volumeDelta": -42
    }
}

adjustVolumeのリクエスト本文のパラメーター

フィールド 説明 型 必須
volumeDelta エンドポイントのスピーカーの音量を調整する相対的な音量。有効範囲は-100～100です。エンドポイントの音量が「20」に設定されていた場合、エンドポイントの音量を「-30」だけ調整するadjustVolume操作が呼び出されると、エンドポイントの音量が「0」に設定されます。同様に、エンドポイントの音量が「20」に設定されていた場合、エンドポイントの音量を「90」だけ調整するadjustVolume操作が呼び出されると、エンドポイントの音量が「100」に設定されます。 文字列 ◯

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。
注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。		 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
202 Accepted The request succeeded.
400 Bad Request リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden アクセストークンは有効ですが、必要なLWAスコープの権限をユーザーが持っていません。
404 Not found リクエストされた構成要素がクライアントについて検出されませんでした。
429 Too many requests リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行します。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。1秒後に再試行し、2回以上の再試行は行わないようにします。
503 Service Unavailable サーバーが一時的に使用できません。

エンドポイントの設定値を照会する

GET /v2/endpoints/{endpointId}/settings/{settingName}を呼び出すと、1つのエンドポイントの1つの設定の現在の値を照会できます。また、GET /v2/endpoints/{endpointId}/settings?keys={settingNames}&nextToken={nextToken}&maxResults={maxResults}を呼び出すと、1つのエンドポイントの複数の設定の現在の値を照会できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

サポートされている設定

以下の設定がサポートされています。

設定の名前 説明 応答のフィールド 応答のフィールドの説明 応答のフィールドの型
address addressの設定を取得します。 address エンドポイントの所在地の設定。 オブジェクト
Alexa.DoNotDisturb.doNotDisturb DoNotDisturbの設定を取得します。この設定では、通知やプロアクティブなエクスペリエンス（通話など）でユーザーが妨げられなくなります。 enabled DoNotDisturbの設定が有効な場合はtrue、そうでない場合はfalseです。 ブール値
System.locales ユーザーの優先ロケールを取得します。Alexaデバイスのコンテキストでは、この設定により、Alexa搭載デバイスで理解される言語、応答に使用される言語が制御されます。 locales ロケール文字列のリスト。ロケールは2つまで指定できます。リストの最初の要素が優先ロケールです。すべてのロケールですべての種類のスキルが使用できるわけではありません。 リスト
SpeechRecognizer.wakeWords WakeWordsの設定を取得します。この設定では、Alexaの起動に使用する代替のウェイクワードを制御できます。 wakeWords ウェイクワードのリスト。例：["アレクサ"]。Alexaでサポートされているウェイクワードは、アレクサ、アマゾン、コンピューター、エコーです。現在、一度に指定できるウェイクワードは1つのみです。注： すべてのデバイスおよびロケールですべてのウェイクワードがサポートされているわけではありません。 リスト
SpeechRecognizer.wakeWordConfirmation wakeWordConfirmationの設定を取得します。この設定では、Alexaがウェイクワードを検出したときに、視覚的な表示だけでなく信号音を再生するかどうかをユーザーが指定できます。この信号音は、Alexaが音声入力を待機し、リクエストを受け付けていることを示します。 wakeWordConfirmation 現在のウェイクワードの確認の設定。Alexaでサポートされているウェイクワードの確認の設定は、TONEとNONEです。 文字列
SpeechRecognizer.speechConfirmation speechConfirmationの設定を取得します。この設定では、Alexaに対するリクエストの終了時に短い信号音を再生するかどうかをユーザーが指定できます。この信号音は、Alexaが音声入力の待機とリクエストの受け付けを終了したことを示します。 speechConfirmation 現在の音声認識の確認の設定。Alexaでサポートされている音声認識の確認の設定は、"TONE"と"NONE"です。 文字列
SpeechRecognizer.FollowUp 会話継続モードの設定を取得します。この設定により、アレクサがユーザーからの後続のリクエストを待ち受けることができるようになり、ユーザーがウェイクワードを言う必要がなくなります。 FollowUp 会話継続モードが有効な場合はtrue、そうでない場合はfalseです。 ブール値
Alexa.ManagedDevice.Settings.errorSuppression errorSuppressionの設定を取得します。この設定では、一定のエラーについてデバイスでエラーのオーディオキュー（短い固有のサウンド）を再生するかどうかを制御します。 errorSuppression エラー抑制のリスト。現時点でサポートされる値は、CONNECTIVITYのみです。リストが空の場合（[]）、エラーは抑制されません。 リスト
Alexa.ManagedDevice.Settings.setupModePrivileges setupModePrivilegesの設定を取得します。この設定では、エンドユーザーがセットアップモードのプロセス（アクションボタンを長押しするなど）でデバイスを設定モードにできる機能を制御します。 setupModePrivileges セットアップモードの権限のリスト。Alexaでサポートされているセットアップモードの権限のリストは、["ALL_SETTINGS"]です。["ALL_SETTINGS"]では、エンドユーザーがデバイスをセットアップモードにすることができます。空のリスト（[]）では、セットアップモードは無効です。 リスト
Alexa.ManagedDevice.Settings.maximumVolumeLimit maximumVolumeLimitの設定を取得します。 maximumVolumeLimit 0～100の数値です（両端の値を含みます）。 整数
System.timeZone timeZoneの設定を取得します。 timeZone Timezone Databaseで定義されているOlson形式に従ったタイムゾーン文字列。例： "America/Los_Angeles"。 文字列
System.temperatureUnit temperatureUnitの設定を取得します。 temperatureUnit 温度の文字列（"CELSIUS"または"FAHRENHEIT"）。 文字列
System.distanceUnits distanceUnitsの設定を取得します。 distanceUnits 距離の単位の文字列（"METRIC"または"IMPERIAL"）。 文字列
Accessibility.Captions.AlexaCaptions.enablement AlexaCaptionsの設定を取得します。 AlexaCaptions "ENABLED"または"DISABLED"。 文字列
Accessibility.Captions.ClosedCaptions.enablement ClosedCaptionsの設定を取得します。 ClosedCaptions "ENABLED"または"DISABLED"。 文字列
Accessibility.Display.Magnifier.enablement Magnifierの設定を取得します。 Magnifier "ENABLED"または"DISABLED"。 文字列
Accessibility.Display.ColorInversion.enablement ColorInversionの設定を取得します。 ColorInversion "ENABLED"または"DISABLED"。 文字列

エンドポイントの単一の設定を照会する

GET /v2/endpoints/{endpointId}/settings/{settingName}を呼び出すと、1つのエンドポイントの1つの設定の現在の値を照会できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/{SettingName} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

応答本文

  {value}

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

エンドポイントの複数の設定を照会する

GET /v2/endpoints/{endpointId}/settings?keys={settingNames}&nextToken={nextToken}&maxResults={maxResults}を呼び出すと、1つのエンドポイントの複数の設定の現在の値を照会できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエストのクエリパラメーター

フィールド 説明 型 必須
keys カンマ区切りで指定する、照会する設定名。 文字列 ◯
nextToken 次のページを照会するためにクライアントが使用するトークン。 文字列 ✕
maxResults このページでクライアントが要求する結果の最大数。 文字列 ✕

リクエスト本文

なし。

応答ヘッダー

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

リクエストの形式

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

GET /v2/endpoints/{endpointId}/settings?keys={settingNames}&nextToken={nextToken}&maxResults={maxResults} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

応答本文

フィールド 説明 型 必須
paginationContext nextTokenのプロパティを持つオブジェクト。これは、クライアントから次のページの後続のリクエストを渡すためのものです。nextTokenが存在しない場合、これが最終ページとなります。 文字列 ✕
settings 2つのプロパティ（keyおよびvalue）を持つオブジェクトで構成された配列。返される設定の順序は保証されません。 文字列 ✕
errors それぞれがkey、status、code、messageのプロパティを持つオブジェクトで構成された配列。errorsが存在しない場合、すべての照会が正常に完了しており、結果がsettingsに格納されています。 文字列 ✕ 
{
    "paginationContext": {
        "nextToken": "{nextToken}"
    },
    "settings": [
        {
            "key": "{settingName1}",
            "value": {value1}
        },
        {
            "key": "{settingName2}",
            "value": {value2}
        },
        ...
    ],
    "errors": [
        {
            "status": {status3},
            "key": "{settingName3}",
            "code": "{code3}",
            "message": "{message3}"
        },
        {
            "status": {status4},
            "key": "{settingName4}",
            "code": "{code4}",
            "message": "{message4}"
        },
        ...
    ]
}

エラー応答

HTTP/1.1 {ErrorCode}
{
    "code": "{ErrorCode}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
code エラーコード。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

addressの設定を取得する

GET /v2/endpoints/{endpointId}/settings/addressを呼び出すと、エンドポイントの所在地の住所を取得できます。Alexaは地域検索や天気などの機能でこの設定を使用します。詳細については、所在地情報を使用してスキルを拡張するを参照してください。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/address HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

{
    "address": {
        "addressLine1": "221 Baker Ave",
        "addressLine2": "",
        "addressLine3": "",
        "city": "Sunnyvale",
        "stateOrRegion": "California",
        "districtOrCounty": "",
        "postalCode": "94085",
        "countryCode": "US"
    }
}

応答本文のパラメーター

フィールド 説明 型 必須
address デバイスの所在地。 Address ◯

Addressオブジェクト

パラメーター 説明 型 必須
addressLine1 住所の1行目です。 文字列 ◯
addressLine2 住所の2行目です。 文字列 必須。空文字列になる場合もあります。
addressLine3 住所の3行目です。 文字列 必須。空文字列になる場合もあります。
city リクエストで指定されたエンドポイントの市区町村です。 文字列 ◯
stateOrRegion リクエストで指定されたエンドポイントに関連付けられている州や地域の省略形です。米国以外の国ではこの値は空文字列になることがあります。 文字列 ◯
districtOrCounty デバイスに関連付けられている地域または郡。米国以外の国ではこの値は空文字列になることがあります。 文字列 ◯
postalCode リクエストで指定されたエンドポイントの郵便番号です。 文字列 ◯
countryCode リクエストで指定されたエンドポイントの、2文字の国コード（リージョンコード）です。 文字列 ◯

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行します。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。
503 Service Unavailable サービスが一時的に使用できません。

DoNotDisturbの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Alexa.DoNotDisturb.doNotDisturbを呼び出すと、DoNotDisturbの設定を取得できます。この設定では、通知やプロアクティブなエクスペリエンス（通話など）でユーザーが妨げられなくなります。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/Alexa.DoNotDisturb.doNotDisturb HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   true

応答本文の値

DoNotDisturbの設定が有効な場合はtrue、そうでない場合はfalseとなるブール値。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

localesの設定を取得する

GET /v2/endpoints/{endpointId}/settings/System.localesを呼び出すと、ユーザーの優先ロケールを取得できます。Alexaデバイスのコンテキストでは、この設定により、Alexa搭載デバイスで理解される言語、応答に使用される言語が制御されます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/System.locales HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   ["en-US", "es-US"]

   ["en-US", "fr-FR"]

応答本文の値

最大2つのロケール文字列のリスト。リストの最初の要素が優先ロケールです。すべてのロケールですべての種類のスキルが使用できるわけではありません。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

WakeWordsの設定を取得する

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWordsを呼び出すと、WakeWordsの設定を取得できます。この設定では、ユーザーがAlexaの起動に使用できる代替のウェイクワードを制御できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWords HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   ["ALEXA"]

応答本文の値

現在有効なウェイクワードのリスト。例：["アレクサ"]。Alexaでサポートされているウェイクワードは、アレクサ、アマゾン、コンピューター、エコーです。現在、一度に指定できるウェイクワードは1つのみです。注： すべてのデバイスおよびロケールですべてのウェイクワードがサポートされているわけではありません。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

wakeWordConfirmationの設定を取得する

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWordConfirmationを呼び出すと、リクエスト開始時のサウンドの設定を更新できます。この設定では、Alexaがウェイクワードを検出したときに、視覚的な表示だけでなく信号音を再生するかどうかをユーザーが指定できます。この信号音は、Alexaが音声入力を待機し、リクエストを受け付けていることを示します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWordConfirmation HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   "NONE"

応答の値

現在のウェイクワードの確認の設定。Alexaでサポートされているウェイクワードの確認の設定は、TONEとNONEです。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

SpeechConfirmationの設定を取得する

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.speechConfirmationを呼び出すと、リクエスト終了時のサウンドを取得できます。この設定により、Alexaへのリクエストの終了時に、Alexaが音声入力の待機とリクエストの受け付けを終了したことを示す短い信号音を再生するかどうかをユーザーが指定できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.speechConfirmation HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   "NONE"

応答の値

現在の音声認識の確認の設定。Alexaでサポートされている音声認識の確認の設定は、"TONE"と"NONE"です。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

errorSuppressionの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.errorSuppressionを呼び出すと、エラー抑制のリストを取得できます。この設定では、一定のエラーについてデバイスでエラーのオーディオキュー（短い固有のサウンド）を再生するかどうかを制御します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.errorSuppression HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   ["CONNECTIVITY"]

応答本文の値

エラー抑制のリスト。現時点でサポートされる値は、["CONNECTIVITY"]のみです。リストが空の場合、抑制されるエラーはありません。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされた構成要素がクライアントについて検出されませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

setupModePrivilegesの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.setupModePrivilegesを呼び出すと、セットアップモードの権限のリストを取得できます。この設定では、エンドユーザーがセットアップモードのプロセス（アクションボタンを長押しするなど）でデバイスを設定モードにできる機能を制御します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.setupModePrivileges HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   ["ALL_SETTINGS"]

応答本文の値

セットアップモードの権限のリスト。Alexaでサポートされているセットアップモードの権限のリストは、["ALL_SETTINGS"]です。["ALL_SETTINGS"]では、エンドユーザーがデバイスをセットアップモードにすることができます。空のリスト（[]）では、セットアップモードは無効です。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

maximumVolumeLimitの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.maximumVolumeLimitを呼び出すと、最大音量の上限を取得できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.maximumVolumeLimit HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   42

応答本文の値

0～100の整数値（両端の値を含みます）。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

timeZoneの設定を取得する

GET /v2/endpoints/{endpointId}/settings/System.timeZoneを呼び出すと、タイムゾーンを取得できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/System.timeZone HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   "America/Los_Angeles"

応答本文の値

Timezone Databaseで定義されているOlson形式に従ったタイムゾーン文字列。例： "America/Los_Angeles"。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

temperatureUnitの設定を取得する

GET /v2/endpoints/{endpointId}/settings/System.temperatureUnitを呼び出すと、温度の単位（摂氏または華氏）の設定を取得できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/System.temperatureUnit HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   "CELSIUS"

応答本文の値

温度の単位の文字列： "CELSIUS"または"FAHRENHEIT"。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

distanceUnitsの設定を取得する

GET /v2/endpoints/{endpointId}/settings/System.distanceUnitsを呼び出すと、距離の単位の設定（メートル法またはヤード・ポンド法）を取得できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/System.distanceUnits HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   "METRIC"

応答本文の値

距離の単位の文字列： "METRIC"または"IMPERIAL"。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

AlexaCaptionsの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Accessibility.Captions.AlexaCaptions.enablementを呼び出すと、Alexaのキャプションの設定を取得できます。

この設定では、マルチメディアデバイスで次の情報を表示するかどうかを制御します。

  • Alexaのキャプション。AlexaがSpeechSynthesizerを利用して話した内容をテキストで提示します。Alexa Voice Service（AVS）を使用するすべてのドメインでキャプションを提供する必要があります。
  • AudioPlayerディレクティブに伴うキャプション。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、カナダ、フランス、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/Accessibility.Captions.AlexaCaptions.enablement HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   "ENABLED"

応答本文の値

この設定の現在の値を示す文字列： "ENABLED"または"DISABLED"。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

ClosedCaptionsの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Accessibility.Captions.AlexaCaptions.enablementを呼び出すと、クローズドキャプションの設定を取得できます。

この設定では、マルチメディアデバイスでビデオコンテンツのクローズドキャプションを表示するかどうかを制御します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、カナダ、フランス、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/Accessibility.Captions.ClosedCaptions.enablement HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   "ENABLED"

応答本文の値

この設定の現在の値を示す文字列： "ENABLED"または"DISABLED"。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

Magnifierの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Accessibility.Display.Magnifier.enablementを呼び出すと、デバイスの拡大鏡の設定を取得できます。

この設定により、デバイスのユーザーが画面上の項目を拡大して読みやすくすることができます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、カナダ、フランス、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/Accessibility.Display.Magnifier.enablement HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   "ENABLED"

応答本文の値

この設定の現在の値を示す文字列： "ENABLED"または"DISABLED"。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

ColorInversionの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Accessibility.Display.ColorInversion.enablementを呼び出すと、画面の色の反転の設定を取得できます。

この設定により、デバイスのユーザーが画面の表示色を反転させて読みやすくすることができます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、カナダ、フランス、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/Accessibility.Display.ColorInversion.enablement HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   "ENABLED"

応答本文の値

この設定の現在の値を示す文字列： "ENABLED"または"DISABLED"。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

複数の設定を取得する

GET /v2/endpoints/{endpointId}/settings?keys={settingNames}&nextToken={nextToken}&maxResults={maxResults}を呼び出すと、複数の設定の値を取得できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings?keys={settingNames}&nextToken={nextToken}&maxResults={maxResults} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエストのクエリパラメーター

フィールド 説明 型 必須
keys カンマ区切りで指定する、照会する設定名。 文字列 ◯
nextToken 次のページを照会するためにクライアントが使用するトークン。 文字列 ✕
maxResults このページでクライアントが要求する結果の最大数。 文字列 ✕

リクエスト本文

なし。

リクエストの例

GET /v2/endpoints/{endpointId}/settings?keys=System.temperatureUnit,System.distanceUnits,Alexa.DoNotDisturb.doNotDisturb,System.timeZone HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文のエラー

HTTPの応答コードが200の場合、個々の設定に対する照会が失敗している可能性があります。その場合は応答本文にエラーの記載があり、詳細が含まれます。

ステータス コード 説明
204 NO_CONTENT 設定は存在していますが、値が含まれていません。
403 ACCESS_DENIED 特定の設定にアクセスする権限が付与されていません。
404 INVALID_KEY 設定のキーが存在しないか、無効です。
500 INTERNAL_SERVER_ERROR 内部サービスエラーのため、特定の設定の照会を処理できませんでした。

応答本文の例

{
    "paginationContext": {},
    "settings": [
        {
            "key": "System.distanceUnits",
            "value": "IMPERIAL"
        },
        {
            "key": "System.temperatureUnit",
            "value": "CELSIUS"
        }
    ],
    "errors": [
        {
            "status": 204,
            "key": "System.timeZone",
            "code": "NO_CONTENT",
            "message": "Setting value is empty"
        },
        {
            "status": 403,
            "key": "Alexa.DoNotDisturb.doNotDisturb",
            "code": "ACCESS_DENIED",
            "message": "The access to the specific setting is unauthorized"
        }
    ]
}

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

FollowUpの設定を取得する

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.FollowUp.modeを呼び出すと、会話継続モードの設定を取得できます。有効な値：trueまたはfalse。この設定により、アレクサがユーザーからの後続のリクエストを待ち受けることができるようになり、ユーザーがウェイクワードを言う必要がなくなります。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.FollowUp.mode HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   true

応答本文の値

現在の会話継続モードの設定（trueまたはfalse）。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

speakingRateの設定を取得する

GET /v2/endpoints/{endpointId}/settings/SpeechSynthesizer.speakingRateを呼び出すと、話す速度の設定を取得できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/SpeechSynthesizer.speakingRate HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文の例

   0.75

応答本文の値

応答本文に話す速度が含まれています。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
204 No Content 設定は存在していますが、値が含まれていません。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

エンドポイントの設定値を更新する

PUT /v2/endpoints/{endpointId}/settings/{settingName}を呼び出すと、エンドポイントのほとんどの設定の現在の値を更新できます。ただし、addressの設定は例外で、この設定にはPOSTを使用します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

サポートされている設定

以下の設定がサポートされています。

設定の名前 説明 リクエストのフィールド リクエストのフィールドの説明 リクエストのフィールドの型
address addressの設定を更新します。 address デバイスの所在地。 オブジェクト
Alexa.DoNotDisturb.doNotDisturb DoNotDisturbの設定を更新します。この設定では、通知やプロアクティブなエクスペリエンス（通話など）でユーザーが妨げられなくなります。 enabled DoNotDisturbの設定が有効な場合はtrue、そうでない場合はfalseです。 ブール値
System.locales ユーザーの優先ロケールを更新します。Alexaデバイスのコンテキストでは、この設定により、Alexa搭載デバイスで理解される言語、応答に使用される言語が制御されます。 locales ロケール文字列のリスト。ロケールは最大2つ指定できます。リストの最初の要素が優先ロケールです。すべてのロケールですべての種類のスキルが使用できるわけではありません。 リスト
SpeechRecognizer.wakeWords wakeWordsの設定を更新します。この設定では、ユーザーがAlexaの起動に使用できる代替のウェイクワードを制御できます。 wakeWords ウェイクワードのリスト。例：["アレクサ"]。Alexaでサポートされているウェイクワードは、アレクサ、アマゾン、コンピューター、エコーです。現在、一度に指定できるウェイクワードは1つのみです。注： すべてのデバイスおよびロケールですべてのウェイクワードがサポートされているわけではありません。 リスト
SpeechRecognizer.wakeWordConfirmation wakeWordConfirmationの設定を更新します。この設定では、Alexaがウェイクワードを検出したときに、視覚的な表示だけでなく信号音を再生するかどうかをユーザーが指定できます。この信号音は、Alexaが音声入力を待機し、リクエストを受け付けていることを示します。 wakeWordConfirmation 設定するウェイクワードの確認の設定。Alexaでサポートされているウェイクワードの確認の設定は、"TONE"と"NONE"です。 文字列
SpeechRecognizer.speechConfirmation speechConfirmationの設定を更新します。この設定では、Alexaに対するリクエストの終了時に短い信号音を再生するかどうかをユーザーが指定できます。この信号音は、Alexaが音声入力の待機とリクエストの受け付けを終了したことを示します。 speechConfirmation 現在の音声認識の確認の設定。Alexaでサポートされている音声認識の確認の設定は、"TONE"と"NONE"です。 文字列
SpeechRecognizer.FollowUp 会話継続モードの設定を更新します。この設定により、アレクサがユーザーからの後続のリクエストを待ち受けることができるようになり、ユーザーがウェイクワードを言う必要がなくなります。 FollowUp 会話継続モードが有効な場合はtrue、そうでない場合はfalseです。 ブール値
Alexa.ManagedDevice.Settings.errorSuppression errorSuppressionの設定を更新します。この設定では、一定のエラーについてデバイスでエラーのオーディオキュー（短い固有のサウンド）を再生するかどうかを制御します。 errorSuppression エラー抑制のリスト。現時点でサポートされる値は、CONNECTIVITYのみです。リストが空の場合（[]）、エラーは抑制されません。 リスト
Alexa.ManagedDevice.Settings.maximumVolumeLimit maximumVolumeLimitの設定を更新します。 maximumVolumeLimit 0～100の数値です（両端の値を含みます）。 整数
System.timeZone timeZoneの設定を更新します。 timeZone Timezone Databaseで定義されているOlson形式に従ったタイムゾーン文字列。例： "America/Los_Angeles"。 文字列
System.temperatureUnit temperatureUnitの設定を更新します。 temperatureUnit 温度の文字列（"CELSIUS"または"FAHRENHEIT"）。 文字列
System.distanceUnits distanceUnitsの設定を更新します。 distanceUnits 距離の単位の文字列（"METRIC"または"IMPERIAL"）。 文字列
Accessibility.Captions.AlexaCaptions.enablement AlexaCaptionsの設定を更新します。 AlexaCaptions "ENABLED"または"DISABLED"。 文字列
Accessibility.Captions.ClosedCaptions.enablement ClosedCaptionsの設定を更新します。 ClosedCaptions "ENABLED"または"DISABLED"。 文字列
Accessibility.Display.Magnifier.enablement Magnifierの設定を更新します。 Magnifier "ENABLED"または"DISABLED"。 文字列
Accessibility.Display.ColorInversion.enablement ColorInversionの設定を更新します。 ColorInversion "ENABLED"または"DISABLED"。 文字列

リクエストの形式

GET /v2/endpoints/{endpointId}/settings/{SettingName} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   {value}

応答ヘッダー

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

addressの設定を更新する

POST /v2/endpoints/{endpointId}/settings/addressを呼び出すと、エンドポイントの所在地の住所を設定できます。Alexaは地域検索や天気などの機能でこの設定を使用します。詳細については、所在地情報を使用してスキルを拡張するを参照してください。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

POST /v2/endpoints/{endpointId}/settings/address HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

{
    "address": {
        "addressLine1": "221 Baker Ave",
        "addressLine2": "",
        "addressLine3": "",
        "city": "Sunnyvale",
        "stateOrRegion": "California",
        "districtOrCounty": "",
        "postalCode": "94085",
        "countryCode": "US"
    }
}

リクエスト本文のパラメーター

フィールド 説明 型 必須
address デバイスの所在地。 Address ◯

Addressオブジェクト

パラメーター 説明 型 必須
addressLine1 住所の1行目です。 文字列 ◯
addressLine2 住所の2行目です。 文字列 必須。空文字列になる場合もあります。
addressLine3 住所の3行目です。 文字列 必須。空文字列になる場合もあります。
city リクエストで指定されたエンドポイントの市区町村です。 文字列 ◯
stateOrRegion リクエストで指定されたエンドポイントに関連付けられている州や地域の省略形です。米国以外の国ではこの値は空文字列になることがあります。 文字列 ◯
districtOrCounty デバイスに関連付けられている地域または郡。米国以外の国ではこの値は空文字列になることがあります。 文字列 ◯
postalCode リクエストで指定されたエンドポイントの郵便番号です。 文字列 ◯
countryCode リクエストで指定されたエンドポイントの、2文字の国コード（リージョンコード）です。 文字列 ◯

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
Location: {location}

応答ヘッダーの例

Host: api.amazonalexa.com
X-Amzn-RequestId: 6006f07b-539f-4924-869a-2f8bcf60bdf6
Content-Type: application/json
Location: /v2/endpoints/{endpoint-id}/settings/address

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯
Location 作成された住所への相対パス。 文字列 ◯

応答本文のパラメーター

addressSuggestionsパラメーターとaddressErrorsパラメーターは相互に排他的です。

パラメーター 説明 型 必須
address デバイスの所在地。 Address 201の場合は必須、400の場合は任意
addressSuggestions 入力された住所が無効な場合の住所に関する提案。 住所に関する提案のリスト 400の場合は任意
addressErrors 入力された住所が無効な場合の住所に関するエラー。 住所に関するエラーのリスト 400の場合は任意

成功応答本文の例

{
    "address": {
        "addressLine1": "221 Baker Ave",
        "addressLine2": "",
        "addressLine3": "",
        "city": "Sunnyvale",
        "stateOrRegion": "California",
        "districtOrCounty": "",
        "postalCode": "94085",
        "countryCode": "US"
    }
}

エラー応答本文の例： 400の住所に関する提案

リクエストの形式が正しくないか、必須パラメーターが不足している場合、住所に関する提案のリストが信頼度の高い順に返されます。

{
  "addressSuggestions": [
      {
        "address": {
          "addressLine1":"221 Baker Ave",
          "addressLine2": "",
          "addressLine3": "",
          "city":"Sunnyvale",
          "stateOrRegion":"California",
          "districtOrCounty": "",
          "postalCode":"94085",
          "countryCode":"US"
        }
      }
  ],
  "code": 400,
  "description": "The input address is invalid.Suggested valid addresses are included in the response."
}

エラー応答本文の例： 400の住所に関するエラー

リクエストの形式が正しくないか、必須パラメーターが不足している場合、住所に関するエラーのリストが返されます。

{
  "addressErrors": [
      {
        "code": "FIELD_REQUIRED|FIELD_INVALID",
        "subCode": "ADDRESS_STREET_INCOMPLETE|...",
        "message": "{human-readable message}",
        "element": "ADDRESS_1|ADDRESS_2|..."
      }
    ],
  "code": 400,
  "description": "The input address is invalid.The list of errors is included in the response."
}

住所に関するエラーのオブジェクト

パラメーター 説明 型 必須
code エラーコード 列挙 ✕
subCode 住所要素が無効となっている理由に関する追加情報。 列挙 ✕
message ユーザーが読める形式のメッセージ。 文字列 ✕
element エラーの対象となっている住所要素。 列挙 ✕

住所のエラーコード値

code値 説明
ELEMENT_REQUIRED 必須要素が不足しています。要素名はelementフィールドで指定されます。
ELEMENT_INVALID フィールド内の値が無効です。要素名はelementフィールドで指定されます。

住所のエラーのサブコード値

subCode値 説明
ADDRESS_PRIMARY_RANGE_MISSING_OR_INVALID 住所の番号が有効ではありませんでした。
ADDRESS_STREET_INCOMPLETE 町名および番地が完全ではありませんでした。
ADDRESS_LINES_JUNK_DATA 住所の行のフィールドに無意味なデータが含まれています。
ADDRESS_FIELD_LENGTH_HIGH 住所フィールドの長さが許容される長さを超えています。
ADDRESS_CITY_INVALID 指定された地域内に該当する名前の都市はありません。
ADDRESS_COUNTY_INVALID 指定された郡が正しくありません。
ADDRESS_STATE_INVALID 指定された州（都道府県）が正しくありません。
ADDRESS_ZIP_INVALID 指定された州（都道府県）や都市、町名に対して、指定された郵便番号が正しくありません。
ADDRESS_STREET_NOT_FOUND 指定された都市に存在しない町名です。
ADDRESS_MULTIBYTE_CHARACTERS フィールドにマルチバイト文字が入力されています。
ADDRESS_DOOR_LEVEL_INFO_MISSING 住所に各戸レベルの情報が不足しています。
FIELD_EMPTY 必須フィールドが空白になっています。

住所要素の値

住所要素 説明
ADDRESS_1 住所の1行目。
ADDRESS_2 住所の2行目。
ADDRESS_3 住所の3行目。
STREET_NAME 住所の中の町名。
BUILDING_NUMBER 建物番号。
COMPLEMENT アパートの部屋番号など、建物内の各部に付された番号。
NEIGHBORHOOD 近隣（Neighborhood）は、市より小さな地域です。
CITY 対象の住所が含まれる都市や地方自治体。
STATE 対象の住所が含まれる米国の州または領土。
COUNTRY 対象の住所が含まれる国。
ZIP 5桁または9桁の郵便番号。
COUNTY 対象の住所が含まれる郡。
COUNTRY_CODE 住所の国コード。

HTTP応答コード

ステータスコード 名前 説明
201 Accepted The request succeeded.
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターが不足しているか、無効な住所になっていて、住所に関する提案があります。詳細について、エラー応答本文の例： 400の住所に関する提案およびエラー応答本文の例： 400の住所に関するエラーを参照してください。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
429 Too many requests リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行します。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。
503 Service Unavailable サービスが一時的に使用できません。

DoNotDisturbの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Alexa.DoNotDisturb.doNotDisturbを呼び出すと、DoNotDisturbの設定を更新できます。この呼び出しにより、通知やプロアクティブなエクスペリエンス（通話など）でユーザーが妨げられなくなります。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/Alexa.DoNotDisturb.doNotDisturb HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   true

リクエスト本文の値

DoNotDisturbの設定を有効にするにはtrue、無効にするにはfalseとするブール値です。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされた構成要素がクライアントについて検出されませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

localesの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/System.localesを呼び出すと、ロケールの設定を更新できます。Alexaデバイスのコンテキストでは、この設定により、Alexa搭載デバイスで理解される言語、応答に使用される言語が制御されます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/System.locales HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   ["en-US", "es-US"]

   ["en-US", "fr-FR"]

リクエスト本文の値

ロケール文字列のリスト。1つ以上、2つまでのロケールを指定します。リストの最初の要素で優先ロケールを指定します。次のロケールがサポートされています：en-CA、en-GB、en-US、fr-FR、fr-CA。このAPIでは次の言語ペアもサポートされています：en-US/fr-FR、en-CA/fr-CA。すべてのロケールですべての種類のスキルが使用できるわけではありません。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

wakeWordsの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWordsを呼び出すと、WakeWordsの設定を更新できます。この設定では、Alexaの起動に使用する代替のウェイクワードを制御できます。

サポートされているウェイクワード： アレクサ、アマゾン、コンピューター、エコー。現在、一度に指定できるウェイクワードは1つのみです。注： すべてのデバイスおよびロケールですべてのウェイクワードがサポートされているわけではありません。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWords HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   ["ALEXA"]

リクエスト本文の値

ウェイクワードのリスト。例：["アレクサ"]。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

wakeWordConfirmationの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWordConfirmationを呼び出すと、リクエスト開始時のサウンドの設定を更新できます。この設定では、Alexaがウェイクワードを検出したときに、視覚的な表示だけでなく信号音を再生するかどうかをユーザーが指定できます。この信号音は、Alexaが音声入力を待機し、リクエストを受け付けていることを示します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWordConfirmation HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   "NONE"

リクエスト本文の値

設定するウェイクワードの確認の設定を含む文字列。Alexaでサポートされているウェイクワードの確認の設定は、"TONE"と"NONE"です。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

speechConfirmationの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.speechConfirmationを呼び出すと、リクエスト終了時のサウンドの設定を更新できます。この設定により、Alexaへのリクエストの終了時に、Alexaが音声入力の待機とリクエストの受け付けを終了したことを示す短い信号音を再生するかどうかをユーザーが指定できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.speechConfirmation HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   "NONE"

リクエスト本文の値

設定する音声認識の確認の設定を含む文字列。Alexaでサポートされている音声認識の確認の設定は、"TONE"と"NONE"です。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

errorSuppressionの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.errorSuppressionを呼び出すと、エラー抑制のリストを更新できます。この設定では、一定のエラーについてデバイスでエラーのオーディオキュー（短い固有のサウンド）を再生するかどうかを制御します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.errorSuppression HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   ["CONNECTIVITY"]

リクエスト本文の値

エラー抑制のリスト。現時点でサポートされる値は、["CONNECTIVITY"]のみです。リストが空の場合、抑制されるエラーはありません。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされた構成要素がクライアントについて検出されませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

maximumVolumeLimitの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.maximumVolumeLimitを呼び出すと、最大音量の上限を更新できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.maximumVolumeLimit HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   42

リクエスト本文の値

0～100の整数値（両端の値を含みます）。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

timeZoneの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/System.timeZoneを呼び出すと、タイムゾーンを更新できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/System.timeZone HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   "America/Los_Angeles"

リクエスト本文の値

Timezone Databaseで定義されているOlson形式に従ったタイムゾーン文字列。例： "America/Los_Angeles"。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

temperatureUnitの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/System.temperatureUnitを呼び出すと、温度の単位（摂氏または華氏）の設定を更新できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/System.temperatureUnit HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   "CELSIUS"

リクエスト本文の値

温度の文字列： "CELSIUS"または"FAHRENHEIT"。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

distanceUnitsの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/System.distanceUnitsを呼び出すと、距離の単位の設定（メートル法またはヤード・ポンド法）を更新できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/System.distanceUnits HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   "METRIC"

リクエスト本文の値

距離の単位の文字列： "METRIC"または"IMPERIAL"。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

AlexaCaptionsの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Captions.AlexaCaptions.enablementを呼び出すと、Alexaのキャプションの設定を更新できます。

この設定では、マルチメディアデバイスで次の情報を表示するかどうかを制御します。

  • Alexaのキャプション。AlexaがSpeechSynthesizerを利用して話した内容をテキストで提示します。Alexa Voice Service（AVS）を使用するすべてのドメインでキャプションを提供する必要があります。
  • AudioPlayerディレクティブに伴うキャプション。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、カナダ、フランス、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Captions.AlexaCaptions.enablement HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   "ENABLED"

リクエスト本文の値

この設定の目的の値を示す文字列： "ENABLED"または"DISABLED"。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

ClosedCaptionsの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Captions.ClosedCaptions.enablementを呼び出すと、Alexaのキャプションの設定を更新できます。

この設定では、マルチメディアデバイスでビデオコンテンツのクローズドキャプションを表示するかどうかを制御します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、カナダ、フランス、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Captions.ClosedCaptions.enablement HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   "ENABLED"

リクエスト本文の値

この設定の目的の値を示す文字列： "ENABLED"または"DISABLED"。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

Magnifierの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Display.Magnifier.enablementを呼び出すと、デバイスの拡大鏡の設定を更新できます。

この設定により、デバイスのユーザーが画面上の項目を拡大して読みやすくすることができます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、カナダ、フランス、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Display.Magnifier.enablement HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   "ENABLED"

リクエスト本文の値

この設定の目的の値を示す文字列： "ENABLED"または"DISABLED"。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

ColorInversionの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Display.ColorInversion.enablementを呼び出すと、画面の色の反転の設定を取得できます。

この設定により、デバイスのユーザーが画面の表示色を反転させて読みやすくすることができます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、カナダ、フランス、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Display.ColorInversion.enablement HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   "ENABLED"

リクエスト本文の値

この設定の目的の値を示す文字列： "ENABLED"または"DISABLED"。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

応答ヘッダーのパラメーター

フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

FollowUpの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.FollowUp.modeを呼び出すと、会話継続モードの設定を更新できます。有効な値：trueまたはfalse。この設定により、アレクサがユーザーからの後続のリクエストを待ち受けることができるようになり、ユーザーがウェイクワードを言う必要がなくなります。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.FollowUp.mode HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   false

リクエスト本文の値

会話継続モードの新しい設定（trueまたはfalse）。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

speakingRateの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/SpeechSynthesizer.speakingRateを呼び出すと、話す速度の設定を更新できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

PUT /v2/endpoints/{endpointId}/settings/SpeechSynthesizer.speakingRate HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の例

   0.75

リクエスト本文の値

話す速度の新しい設定。有効な値は、 0.75、0.85、1、1.25、1.5、1.75、2です。デフォルトの設定は1です。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

応答本文

なし。

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
204 No Content 設定は適用されました。
400 Bad Request (INVALID_REQUEST, INVALID_VALUE, DEVICE_UNREACHABLE, DEVICE_NOT_SUPPORTED) リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたエンドポイントが見つかりませんでした。
405 Method Not Allowed デバイスで設定がサポートされていません。
429 Too many requests リクエストが制限されています。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。

エンドポイントの登録を解除する

POST /v2/endpoints/{endpointId}/deregisterを呼び出すと、Amazonビジネスカウントからエンドポイントの登録を解除できます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

POST /v2/endpoints/{endpointId}/deregister HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエスト本文

なし。

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

応答本文

なし。

応答ヘッダー

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のID。例：1K82TJNQTXSJFP8NGJP0。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

エラー応答

HTTP/1.1 {ErrorCode}
{
    "type": "{ErrorType}",
    "message": "{ErrorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラータイプ。 文字列 ✕
message エラーのエラーメッセージです。
注： エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。		 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
400 Bad Request リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。
401 Unauthorized アクセストークンがないか、期限切れか、無効です。
403 Forbidden アクセストークンは有効ですが、必要なLWAスコープの権限をユーザーが持っていません。
429 Too many requests リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行します。
500 Internal Server Error 内部サービスエラーのためリクエストを処理できませんでした。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は500以外の応答を受信するまで256秒ごとに再試行します。
503 Service Unavailable サービスが一時的に使用できません。

エンドポイントのフレンドリー名を変更する

POST /v2/endpoints/{endpointId}/friendlyNameを呼び出すと、エンドポイントのフレンドリー名を変更できます。AlexaはGUIおよびVUIのすべてのエクスペリエンスでフレンドリー名を使用します。ユーザーはエンドポイントを操作するのにフレンドリー名を使用できます。例：「アレクサ、｛フレンドリー名｝をオンにして」

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

POST /v2/endpoints/{endpointId}/friendlyName HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文の形式

{
  "type": "PLAIN",
  "value": {
    "text": "{friendlyNameString}"
  }
}

リクエスト本文の例

{
  "type": "PLAIN",
  "value": {
    "text": "My Light"
  }
}

リクエスト本文のパラメーター

フィールド 説明 型 必須
type 名前の値のタイプ。現時点でサポートされる値は、"PLAIN"のみです。 文字列 ◯
value エンドポイントのフレンドリー名が格納されたValueオブジェクト。 値 ◯

Valueオブジェクト

フィールド 説明 型 必須
text フレンドリー名の文字列。文字列は1～128文字のUnicode（UTF-8）文字で構成されている必要があり、特殊文字や句読点を含めることはできません（アポストロフィは使用できます）。次のルールが適用されます。
* 使用できる文字は、数字、文字（漢字や非ラテン文字も許容されます）、空白、アポストロフィです。
* 名前には、1文字以上の数字または文字が含まれている必要があります。		 文字列 ◯

応答ヘッダー

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

エラー応答本文の形式

{
     "type" :  "{errorType}" ,
     "message" :  "{errorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
type エラーのエラータイプ。リクエストが有効で、サービスがリクエストの実行に失敗した場合にのみ存在します。このフィールドはビジネスロジックで使用できます。 文字列 ✕
message エラーのエラーメッセージです。エラーメッセージの表示はデバッグやログ記録のみを目的としたものです。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 文字列 ✕

HTTP応答コード

ステータスコード 型 メッセージ 説明
200 OK The request succeeded.  
400 INVALID_FRIENDLY_NAME The input friendly name has the following problems: {problemString} リクエストに1つ以上の必須パラメーターがないか、1つ以上のパラメーターの値が無効です。
400 DUPLICATE_NAME The input friendly name is already assigned to another device. フレンドリー名は一意である必要があります。
401 UNAUTHORIZED Invalid or missing access token LWAトークンがないか、期限切れか、無効です。
403 FORBIDDEN Forbidden クライアントはリソースのリストを取得できますが、クライアントにはリソースの名前を変更する権限はありません。
404 NO_SUCH_ENDPOINT Endpoint not found パスにエンドポイントが存在しないか、クライアントにリソースのリストを取得する権限がありません。
429 TOO_MANY_REQUESTS Too Many Requests リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行します。
500 INTERNAL_SERVER_ERROR Internal Service Error サービスエラーが発生しました。
503 SERVICE_UNAVAILABLE Service Unavailable サービスを一時的に利用できず、リクエストを処理できません。

エンドポイントの情報を削除する

POST /v2/endpoints/{endpointId}/forgetを呼び出すと、エンドポイントの情報が削除されます。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

米国

リクエストの形式

POST /v2/endpoints/{endpointId}/forget HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

リクエストのパスパラメーター

フィールド 説明 型 必須
endpointId エンドポイントID。"amzn1.alexa.endpoint.{id}"というAmazon Common Identifier（ACI）形式で指定します。 文字列 ◯

リクエスト本文

なし。

応答ヘッダー

HTTP/1.1 200 OK
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド 説明 型 必須
X-Amzn-RequestId リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 文字列 ◯

エラー応答本文の形式

{
    "message": "{errorMessage}"
}

エラー応答のパラメーター

フィールド 説明 型 必須
message エラーのエラーメッセージです。 文字列 ✕

HTTP応答コード

ステータスコード 名前 説明
200 OK The request succeeded.
400 Bad Request リクエストに1つ以上の必須パラメーターがないか、1つ以上のパラメーターの値が無効です。
401 Unauthorized LWAトークンがないか、期限切れか、無効です。
403 Forbidden 操作を実行する権限がユーザーにありません。
404 Not found リクエストされたリソースが見つからないか、クライアントにアクセス権がありません。
429 Too many requests リクエストが制限されました。自動的に再試行を実行しないようにしてください。サービスが復旧するまで待ってから、操作を再試行します。
500 Internal Server Error サービスエラーが発生しました。1秒後に再試行し、待機間隔が256秒になるまで、ゆらぎを持たせたエクスポネンシャルバックオフを行います。それ以降、500以外の応答を受け取るまで、256秒ごとに再試行します。
503 Service Unavailable サービスを一時的に利用できず、リクエストを処理できません。

最終更新日: 2023 年 03 月 06 日