エンドポイントAPI

エンドポイントAPI

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

APIエンドポイント

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

認証

すべてのAPIリクエストには認可ヘッダーが必要であり、その値には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

addOrUpdateWifiConfigurationsを実行する

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

話す速度の設定を更新する

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

米国

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

米国、カナダ

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

米国

リクエスト

Amazonビジネスアカウントに登録されているエンドポイントのリストを取得するには、GET /v2/endpoints?owner=~callerを呼び出します。

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

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

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

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

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

各エンドポイントの詳細を含めるには、以下の例のようにexpand=allパラメーターを使用します。

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

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

各エンドポイントの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: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 Display Categoriesオブジェクトです。    
paginationContext Pagination Contextオブジェクトです。これが存在する場合、応答に含まれている結果は完全ではありません。存在しない場合、すべての結果が既に返されています。 オブジェクト ✕

NameValueオブジェクト

フィールド 説明 型
type 名前の値のタイプです。現在サポートされている値は、"PLAIN"のみです。これは、valueプロパティにこのプロパティのプレーンテキスト値が格納されていることを示します。 文字列
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"
}

Display Categoriesオブジェクト

フィールド 説明 型
primary エンドポイントのプライマリーカテゴリーです。 Display Categoryオブジェクト
all エンドポイントのすべてのカテゴリーです。 配列

例

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

Display Categoryオブジェクト

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

例

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

Pagination Contextオブジェクト

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

例

{
  "nextToken": "ABCD123"
}

エラー応答

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

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

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

HTTP応答コード

ステータスコード 名前 説明
200 OK リクエストが成功しました。
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

米国

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

米国、カナダ

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

米国

リクエスト

1つのエンドポイントを取得し、呼び出し元にアクセス権限のあるすべてのエンドポイントアトリビュートの一覧を取得するには、GET /v2/endpoints/{endpointId}?expand=allを呼び出します。

リクエストの形式の例

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

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

以下の例では、エンドポイントのエンドポイントIDのみを取得します。

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

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

以下の例では、エンドポイントのすべてのアトリビュートの一覧を取得します。

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

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

以下の例では、エンドポイントのすべてのアトリビュートの一覧とspeaker機能を取得します。

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

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

フィールド 説明 型 必須
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 Display Categoriesオブジェクトです。    
operations サポートされている操作を表すOperationオブジェクトのリストです。 リスト ✕

エラー応答

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

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

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

HTTP応答コード

ステータスコード 名前 説明
200 Success リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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トークン}

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トークン}

リクエスト本文

ありません。

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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を実行する

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

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

Healthcare Hospitality Residential Senior Living Core

米国

米国、カナダ

米国、カナダ

米国、カナダ

米国

リクエストの形式

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

リクエスト本文の形式

{
    "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を実行する

保存したWi-Fi設定をエンドポイントに関連付けるには、POST /v2/endpoints/endpointId/features/connectivity/addOrUpdateWifiConfigurationsを呼び出します。エンドポイントごとに、最大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トークン}
Content-Type: application/json

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

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

リクエスト本文の形式

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

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

フィールド 説明 型 必須

ssid

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

文字列

◯

keyManagement

Wi-Fi設定のセキュリティタイプです。POST 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のインストールステータスを取得する

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

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

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トークン}

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

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

応答本文の例

{
     "status": "TIMEOUT"
}

応答本文のパラメーター

フィールド 説明 型 必須
status 指定されたaddOrUpdateWifiConfigurations操作の状態です。Statusオブジェクトとして表します。 オブジェクト ◯

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 エンドポイントが別のエンドポイントと結合されたため、基になるリソースが変更されました。応答本文には、新しいエンドポイント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トークン}

リクエスト本文

ありません。

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

フィールド 説明 型 必須
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}"
}

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

フィールド 説明 型 必須
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トークン}

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

フィールド 説明 型 必須
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

色相の値です。

倍精度

◯

payload.color.saturation

彩度の値です。

倍精度

◯

payload.color.brightness

輝度の値です。

倍精度

◯

成功応答ヘッダー

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}"
}

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

フィールド 説明 型 必須
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トークン}

リクエスト本文

ありません。

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

フィールド 説明 型 必須
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}"
}

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

フィールド 説明 型 必須
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トークン}

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

フィールド 説明 型 必須
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}"
}

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

フィールド 説明 型 必須
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トークン}

リクエスト本文

ありません。

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

フィールド 説明 型 必須
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}"
}

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

フィールド 説明 型 必須
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トークン}

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

フィールド 説明 型 必須
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}"
}

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

フィールド 説明 型 必須
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トークン}

リクエスト本文

ありません。

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

フィールド 説明 型 必須
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 このフィールドが存在する場合は、プロパティ値の取得中にエラーが発生したことを示します。 オブジェクト ✕

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トークン}

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

フィールド 説明 型 必須
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を取得する

指定したエンドポイントのtemperatureSensor機能のプロパティと、それらに対応する値を取得するには、GET /v2/endpoints/{endpointId}/features/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トークン}

リクエスト本文

ありません。

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

フィールド 説明 型 必須
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 温度です。 倍精度
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トークン}

リクエスト本文

ありません。

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

フィールド 説明 型 必須
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 温度です。 倍精度
scale 温度の単位です。 温度単位の文字列

温度の値の例

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

温度単位

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

ThermostatModeの値

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

サポートされている設定

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

機能の操作

サポートされている操作

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

adjustTargetSetpoint

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

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

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トークン}

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

フィールド 説明 型 必須
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トークン}

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

フィールド 説明 型 必須
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トークン}

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

フィールド 説明 型 必須
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トークン}

リクエスト本文

ありません。

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

フィールド 説明 型 必須
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 このフィールドが存在する場合は、プロパティ値の取得中にエラーが発生したことを示します。 オブジェクト ✕

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

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

HTTP応答コード

ステータスコード 名前 説明
200 OK リクエストが成功しました。
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トークン}

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

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

setVolumeのリクエスト本文の例

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

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

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

adjustVolumeのリクエスト本文の例

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

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

フィールド 説明 型 必須
volumeDelta エンドポイントのスピーカー音量を調整する相対音量です。有効な範囲は-100～100です。エンドポイントの音量が既に「20」に設定されている場合、adjustVolume操作を呼び出してエンドポイントの音量を「-30」で調整すると、エンドポイントの音量は0に設定されます。同様に、エンドポイントの音量が既に「20」に設定されている場合、adjustVolume操作を呼び出してエンドポイントの音量を「90」で調整すると、エンドポイントの音量は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 リクエストが成功しました。
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 サーバーが一時的に使用できません。

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

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

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

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"] のようになります。Alexaでサポートされているウェイクワードは、ALEXA、AMAZON、COMPUTER、ECHOです。現在、指定できるウェイクワードは一度に1つだけです。注： すべてのデバイスとロケールですべてのウェイクワードがサポートされるとは限りません。フランス（fr-FR）では、COMPUTERはサポートされません。 リスト
SpeechRecognizer.wakeWordConfirmation wakeWordConfirmationの設定を取得します。この設定により、ユーザーは、Alexaデバイスがウェイクワードを検出したときに、視覚的な表示だけでなく信号音が再生されるようにするかどうかを指定できます。信号音は、Alexaがリクエストの聞き取りと解釈を開始したことを示します。 wakeWordConfirmation 現在のウェイクワード確認の設定です。Alexaでサポートされているウェイクワード確認の設定は、TONEおよびNONEです。 文字列
SpeechRecognizer.speechConfirmation speechConfirmationの設定を取得します。この設定により、ユーザーは、Alexaへのリクエストを言い終えたときに、短い信号音が再生されるようにするかどうかを指定できます。信号音は、Alexaがリクエストの聞き取りと解釈を終了したことを示します。 speechConfirmation 現在の音声認識確認の設定です。Alexaでサポートされている音声認識確認の設定は、"TONE"および"NONE"です。 文字列
SpeechRecognizer.FollowUp 会話継続モードの設定を取得します。この設定は、ユーザーがウェイクワードを言わなくても、Alexaがユーザーから続けてリクエストを聞き取ることができるようにします。 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 タイムゾーン文字列です。Time Zone Databaseで定義されているOlson形式に従います。たとえば、 "America/Los_Angeles"のようになります。 文字列
System.temperatureUnit temperatureUnitの設定を取得します。 temperatureUnit 温度の文字列です。"CELSIUS"または"FAHRENHEIT"です。 文字列
System.distanceUnits distanceUnitsの設定を取得します。 distanceUnits 距離の単位の文字列です。"METRIC"または"IMPERIAL"です。 文字列
Accessibility.Captions.AlexaCaptions.enablement AlexaCaptionsの設定を取得します。注： キャプションは、英国（en-GB）とフランス（fr-FR）ではサポートされません。 AlexaCaptions "ENABLED"または"DISABLED"です。 文字列
Accessibility.Captions.ClosedCaptions.enablement ClosedCaptionsの設定を取得します。注： キャプションは、英国（en-GB）とフランス（fr-FR）ではサポートされません。 ClosedCaptions "ENABLED"または"DISABLED"です。 文字列
Accessibility.Display.Magnifier.enablement Magnifierの設定を取得します。注： 拡大鏡は、英国（en-GB）とフランス（fr-FR）ではサポートされません。 Magnifier "ENABLED"または"DISABLED"です。 文字列
Accessibility.Display.ColorInversion.enablement ColorInversionの設定を取得します。注： 色反転は、英国（en-GB）とフランス（fr-FR）ではサポートされません。 ColorInversion "ENABLED"または"DISABLED"です。 文字列

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

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

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

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トークン}

応答本文

  {value}

エラー応答

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

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

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

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

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

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

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トークン}

応答本文

フィールド 説明 型 必須
paginationContext nextTokenのプロパティを持つオブジェクトです。クライアントは、次のページを取得する後続のリクエストにこの値を渡します。nextTokenがない場合は、これが最終ページであることを示します。 文字列 ✕
settings keyとvalueという2つのプロパティを持つオブジェクトの配列です。返される設定の順序は保証されません。 文字列 ✕
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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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の設定を取得する

DoNotDisturbの設定を取得するには、GET /v2/endpoints/{endpointId}/settings/Alexa.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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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の設定を取得する

wakeWordsの設定を取得するには、GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.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トークン}

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

フィールド 説明 型 必須
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"] のようになります。Alexaでサポートされているウェイクワードは、ALEXA、AMAZON、COMPUTER、ECHOです。現在、指定できるウェイクワードは一度に1つだけです。注： すべてのデバイスとロケールですべてのウェイクワードがサポートされるとは限りません。フランス（fr-FR）では、COMPUTERはサポートされません。

エラー応答

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

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

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

HTTP応答コード

ステータスコード 名前 説明
200 OK リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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"

応答本文の値

タイムゾーン文字列です。Time Zone Databaseで定義されているOlson形式に従います。たとえば、 "America/Los_Angeles"のようになります。

エラー応答

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

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

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

HTTP応答コード

ステータスコード 名前 説明
200 OK リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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の設定を取得する

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

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

  • 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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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.ClosedCaptions.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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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トークン}

応答ヘッダー

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 リクエストが成功しました。
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です。この設定は、ユーザーがウェイクワードを言わなくても、Alexaがユーザーから続けてリクエストを聞き取ることができるようにします。

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

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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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"] のようになります。Alexaでサポートされているウェイクワードは、ALEXA、AMAZON、COMPUTER、ECHOです。現在、指定できるウェイクワードは一度に1つだけです。注： すべてのデバイスとロケールですべてのウェイクワードがサポートされるとは限りません。フランス（fr-FR）では、COMPUTERはサポートされません。 リスト
SpeechRecognizer.wakeWordConfirmation wakeWordConfirmationの設定を更新します。この設定により、ユーザーは、Alexaデバイスがウェイクワードを検出したときに、視覚的な表示だけでなく信号音が再生されるようにするかどうかを指定できます。信号音は、Alexaがリクエストの聞き取りと解釈を開始したことを示します。 wakeWordConfirmation ウェイクワード確認の新しい設定です。Alexaでサポートされているウェイクワード確認の設定は、"TONE"および"NONE"です。 文字列
SpeechRecognizer.speechConfirmation speechConfirmationを更新します。この設定により、ユーザーは、Alexaへのリクエストを言い終えたときに、短い信号音が再生されるようにするかどうかを指定できます。信号音は、Alexaがリクエストの聞き取りと解釈を終了したことを示します。 speechConfirmation 現在の音声認識確認の設定です。Alexaでサポートされている音声認識確認の設定は、"TONE"および"NONE"です。 文字列
SpeechRecognizer.FollowUp 会話継続モードの設定を更新します。この設定は、ユーザーがウェイクワードを言わなくても、Alexaがユーザーから続けてリクエストを聞き取ることができるようにします。 FollowUp 会話継続モードが有効な場合はtrue、そうでない場合はfalseです。 ブール値
Alexa.ManagedDevice.Settings.errorSuppression errorSuppressionの設定を更新します。この設定は、特定のエラーに対して、デバイスでオーディオによるエラーの合図（短い特徴的なサウンド）を再生するかどうかを制御します。 errorSuppression エラー抑制のリストです。現在サポートされている値は、CONNECTIVITYのみです。リストが空（[]）の場合、抑制されるエラーはありません。 リスト
Alexa.ManagedDevice.Settings.maximumVolumeLimit maximumVolumeLimitの設定を更新します。 maximumVolumeLimit 0～100の数値です（両端の値を含みます）。 整数
System.timeZone timeZoneの設定を更新します。 timeZone タイムゾーン文字列です。Time Zone Databaseで定義されているOlson形式に従います。たとえば、 "America/Los_Angeles"のようになります。 文字列
System.temperatureUnit temperatureUnitを更新します。 temperatureUnit 温度の文字列です。"CELSIUS"または"FAHRENHEIT"です。 文字列
System.distanceUnits distanceUnitsの設定を更新します。 distanceUnits 距離の単位の文字列です。"METRIC"または"IMPERIAL"です。 文字列
Accessibility.Captions.AlexaCaptions.enablement AlexaCaptionsの設定を更新します。注： キャプションは、英国（en-GB）とフランス（fr-FR）ではサポートされません。 AlexaCaptions "ENABLED"または"DISABLED"です。 文字列
Accessibility.Captions.ClosedCaptions.enablement ClosedCaptionsの設定を更新します。注： キャプションは、英国（en-GB）とフランス（fr-FR）ではサポートされません。 ClosedCaptions "ENABLED"または"DISABLED"です。 文字列
Accessibility.Display.Magnifier.enablement Magnifierの設定を更新します。注： 拡大鏡は、英国（en-GB）とフランス（fr-FR）ではサポートされません。 Magnifier "ENABLED"または"DISABLED"です。 文字列
Accessibility.Display.ColorInversion.enablement ColorInversionの設定を更新します。注： 色反転は、英国（en-GB）とフランス（fr-FR）ではサポートされません。 ColorInversion "ENABLED"または"DISABLED"です。 文字列

リクエストの形式

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

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

フィールド 説明 型 必須
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トークン}

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

フィールド 説明 型 必須
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."
}

Address Errorsオブジェクト

パラメーター 説明 型 必須
code エラーコードです。 列挙 ✕
subCode 住所要素が無効である理由に関する追加情報です。 列挙 ✕
message ユーザーが読める形式のメッセージです。 文字列 ✕
element エラーになっている住所要素です。 列挙 ✕

住所エラーのcodeの値

codeの値 説明
ELEMENT_REQUIRED 必須要素がありません。要素名はelementフィールドで指定されます。
ELEMENT_INVALID フィールド内の値が無効です。要素名はelementフィールドで指定されます。

住所エラーのsubCodeの値

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 市内の小区域を表します。
CITY 住所が属している市や地方自治体です。
STATE 住所が属している米国の州または領土です。
COUNTRY 住所が属している国です。
ZIP 住所の5桁または9桁の郵便番号です。
COUNTY 住所が属している郡です。
COUNTRY_CODE 住所の国コードです。

HTTP応答コード

ステータスコード 名前 説明
201 Accepted リクエストが成功しました。
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の設定を更新する

DoNotDisturbの設定を更新するには、PUT /v2/endpoints/{endpointId}/settings/Alexa.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トークン}

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

フィールド 説明 型 必須
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トークン}

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

フィールド 説明 型 必須
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の設定を更新する

wakeWordsの設定を更新するには、PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWordsを呼び出します。この設定は、Alexaの起動に使用できる代替のウェイクワードを制御します。

サポートされているウェイクワードは、 ALEXA、AMAZON、COMPUTER、ECHOです。現在、指定できるウェイクワードは一度に1つだけです。注： すべてのデバイスとロケールですべてのウェイクワードがサポートされるとは限りません。フランス（fr-FR）では、COMPUTERはサポートされません。

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

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トークン}

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

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

リクエスト本文の例

   ["ALEXA"]

リクエスト本文の値

ウェイクワードのリストです。たとえば、["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トークン}

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

フィールド 説明 型 必須
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トークン}

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

フィールド 説明 型 必須
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トークン}

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

フィールド 説明 型 必須
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トークン}

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

フィールド 説明 型 必須
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トークン}

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

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

リクエスト本文の例

   "America/Los_Angeles"

リクエスト本文の値

タイムゾーン文字列です。Time Zone 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トークン}

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

フィールド 説明 型 必須
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トークン}

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

フィールド 説明 型 必須
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の設定を更新する

Alexaのキャプションの設定を更新するには、PUT /v2/endpoints/{endpointId}/settings/Accessibility.Captions.AlexaCaptions.enablementを呼び出します。

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

  • 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トークン}

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

フィールド 説明 型 必須
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を呼び出します。

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

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

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トークン}

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

フィールド 説明 型 必須
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トークン}

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

フィールド 説明 型 必須
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トークン}

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

フィールド 説明 型 必須
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です。この設定は、ユーザーがウェイクワードを言わなくても、Alexaがユーザーから続けてリクエストを聞き取ることができるようにします。

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

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トークン}

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

フィールド 説明 型 必須
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 内部サービスエラーのためリクエストを処理できませんでした。

話す速度の設定を更新する

話す速度の設定を更新するには、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トークン}

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

フィールド 説明 型 必須
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 内部サービスエラーのためリクエストを処理できませんでした。

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

Amazonビジネスアカウントからエンドポイントの登録を解除するには、POST /v2/endpoints/{endpointId}/deregisterを呼び出します。

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

Healthcare Hospitality Residential Senior Living Core

米国

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

米国、カナダ

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

米国

リクエストの形式

POST /v2/endpoints/{endpointId}/deregister HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}

リクエスト本文

ありません。

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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トークン}

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

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

リクエスト本文の形式

{
  "type": "PLAIN",
  "value": {
    "text": "{friendlyNameString}"
  }
}

リクエスト本文の例

{
  "type": "PLAIN",
  "value": {
    "text": "ライト"
  }
}

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

フィールド 説明 型 必須
type 名前の値のタイプです。現在サポートされている値は、"PLAIN"のみです。 文字列 ◯
value エンドポイントのフレンドリー名を含む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トークン}

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

フィールド 説明 型 必須
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 リクエストが成功しました。
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 月 16 日