エンドポイント設定REST APIリファレンス


エンドポイント設定REST APIリファレンス

エンドポイント設定REST APIを使用すると、デバイスの住所、タイムゾーン、応答不可の設定など、Alexaコネクテッドエンドポイントの設定を表示および更新できます。Alexa Smart Properties(ASP)では、エンドポイントは、Amazon EchoデバイスやAlexaコネクテッド照明など、ASPのゲストや居住者が操作できるAlexaコネクテッドデバイスまたはコンポーネントを表します。Amazonビジネスアカウントで所有されているデバイスの設定を表示および変更する場合は、エンドポイント設定APIとエンドポイントREST APIを併せて使用します。

APIエンドポイント

組織が所在する国に応じて、リクエストヘッダーのHostパラメーターを、以下のいずれかのAPIエンドポイントに設定してください。

エンドポイント

カナダ、米国

https://api.amazonalexa.com

ドイツ、スペイン、フランス、イタリア、英国

https://api.eu.amazonalexa.com

日本

https://api.fe.amazonalexa.com

認証

すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値にはLogin with Amazon(LWA)から取得したアクセストークンが入ります。詳細については、APIアクセスを管理するを参照してください。

操作

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

操作 HTTPメソッドとURI

複数の設定を取得する

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

addressの設定を取得する

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

AlexaCaptionsの設定を取得する

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

ClosedCaptionsの設定を取得する

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

ColorInversionの設定を取得する

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

distanceUnitsの設定を取得する

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

DoNotDisturbの設定を取得する

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

errorSuppressionの設定を取得する

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

FollowUpの設定を取得する

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

localesの設定を取得する

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

Magnifierの設定を取得する

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

maximumVolumeLimitの設定を取得する

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

setupModePrivilegesの設定を取得する

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

speakingRateの設定を取得する

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

speechConfirmationの設定を取得する

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

temperatureUnitの設定を取得する

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

timeFormatの設定を取得する

GET /v2/endpoints/{endpointId}/settings/Alexa.DataFormat.Time.timeFormat

timeZoneの設定を取得する

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

wakeWordConfirmationの設定を取得する

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

wakeWordsの設定を取得する

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

addressを設定する

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

AlexaCaptionsの設定を更新する

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

ClosedCaptionsの設定を更新する

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

ColorInversionの設定を更新する

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

distanceUnitsの設定を更新する

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

DoNotDisturbの設定を更新する

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

errorSuppressionの設定を更新する

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

FollowUpの設定を更新する

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

localesの設定を更新する

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

Magnifierの設定を更新する

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

maximumVolumeLimitの設定を更新する

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

speakingRateの設定を更新する

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

speechConfirmationの設定を更新する

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

temperatureUnitの設定を更新する

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

timeFormatの設定を更新する

PUT /v2/endpoints/{endpointId}/settings/Alexa.DataFormat.Time.timeFormat

timeZoneの設定を更新する

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

wakeWordConfirmationの設定を更新する

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

wakeWordsの設定を更新する

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

複数の設定を取得する

指定されたエンドポイントの複数の設定の現在値を取得します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行し、クエリパスで設定を指定します。複数の設定をリクエストした場合、応答がページ分割される可能性があります。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings?keys={settingName, settingName, ...}&nextToken={nextToken}&maxResults={maxResults}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

settingName

クエリ

設定の名前のカンマ区切りリスト。
少なくとも1つの設定を指定する必要があります。有効な値は Accessibility.Captions.AlexaCaptions.enablementAccessibility.Captions.ClosedCaptions.enablementAccessibility.Display.ColorInversion.enablementAccessibility.Display.Magnifier.enablementaddressAlexa.DataFormat.Time.timeFormatAlexa.DoNotDisturb.doNotDisturbAlexa.ManagedDevice.Settings.errorSuppressionAlexa.ManagedDevice.Settings.maximumVolumeLimitAlexa.ManagedDevice.Settings.setupModePrivilegesSpeechRecognizer.FollowUpSpeechRecognizer.speechConfirmationSpeechRecognizer.wakeWordsSpeechRecognizer.wakeWordConfirmationSystem.distanceUnitsSystem.localesSystem.temperatureUnitSystem.timeZoneです。

文字列

maxResults

クエリ

応答で返される結果の最大数。
デフォルト値は 100です。

整数

nextToken

クエリ

前回の応答で受け取ったトークン。
ページ分割された応答の反復処理を行う場合に含めます。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントのリクエストされた設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

以下は、4つの設定のリクエスト( GET /v2/endpoints/{endpointId}/settings?keys=System.temperatureUnit,System.distanceUnits,Alexa.DoNotDisturb.doNotDisturb,System.timeZone)に対する応答の例です。

{

    "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"
        }
    ],
    "paginationContext": {}
}

応答本文のプロパティ

プロパティ 説明

settings

リクエストされた設定値の順不同のリスト。

オブジェクトの配列

settings[].key

リクエストで指定した設定の名前。

文字列

settings[].value

設定の値。

文字列

errors

(オプション)発生したエラーのリスト。
すべての設定値が正常に取得された場合は含まれません。

オブジェクトの配列

errors[].key

リクエストで指定した設定の名前。

文字列

errors[].status

HTTPステータスコード

文字列

errors[].code

エラーを識別します。

文字列

errors[].message

読み取り可能なエラーメッセージ。
デバッグとログ記録の目的でのみ使用します。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。

文字列

paginationContext

(オプション)nextTokenのラッパー。
応答がページ分割された場合に含まれます。

オブジェクト

paginationContext.nextToken

次に返される設定値のセットを識別します。
この値は、次の複数の設定を取得するリクエストのnextTokenパラメーターに使用します。

文字列

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントのリクエストされた設定の現在値が応答本文に含まれます。個々の設定が失敗した場合、応答にはerrorプロパティが含まれます。

204 No content

設定は存在していますが、設定値が空です。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

addressの設定を取得する

指定されたエンドポイントの住所の設定を取得します。詳細については、所在地情報を使用してスキルを拡張するを参照してください。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

住所を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/address
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントの設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

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

応答本文のプロパティ

プロパティ 説明

address

指定されたエンドポイントの住所。

Addressオブジェクト

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの住所の設定が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

AlexaCaptionsの設定を取得する

指定されたエンドポイントのAlexaキャプションの設定を取得します。

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

  • Alexaキャプション。AlexaがSpeechSynthesizerインターフェースを通じて話した内容をテキストで提示します。
  • AudioPlayerディレクティブで指定されたキャプション。

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

Healthcare Hospitality Senior Living Core

米国

米国、カナダ、イタリア、ドイツ、スペイン、日本

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/Accessibility.Captions.AlexaCaptions.enablement 
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントのAlexaキャプションの設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

"ENABLED"

応答本文のプロパティ

説明

文字列

指定されたエンドポイントのAlexaキャプション設定の現在値。
有効な値は DISABLEDENABLEDです。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

ClosedCaptionsの設定を取得する

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

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

Healthcare Hospitality Senior Living Core

米国

米国、カナダ、イタリア、ドイツ、スペイン、日本

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/Accessibility.Captions.ClosedCaptions.enablement
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントのクローズドキャプションの設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

"ENABLED"

応答本文のプロパティ

説明

文字列

指定されたエンドポイントのクローズドキャプション設定の現在値。
有効な値は DISABLEDENABLEDです。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

ColorInversionの設定を取得する

指定されたエンドポイントの画面の色反転設定を取得します。この設定により、デバイスのユーザーは、画面の表示色を反転させて読みやすくすることができます。

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

Healthcare Hospitality Senior Living Core

米国

米国、カナダ、イタリア、ドイツ、スペイン、日本

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/Accessibility.Display.ColorInversion.enablement
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントの画面の色反転設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

"ENABLED"

応答本文のプロパティ

説明

文字列

指定されたエンドポイントの色反転設定の現在値。
有効な値は DISABLEDENABLEDです。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

distanceUnitsの設定を取得する

指定されたエンドポイントの距離単位(メートル法またはヤード・ポンド法)の設定を取得します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/System.distanceUnits
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントの距離単位の設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

"METRIC"

応答本文のプロパティ

説明

文字列

指定されたエンドポイントの距離単位設定の現在値。
有効な値は IMPERIALMETRICです。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

DoNotDisturbの設定を取得する

指定されたエンドポイントの応答不可の設定を取得します。この設定により、通知やプロアクティブなエクスペリエンス(通話など)がユーザーの妨げになるのを防ぐことができます。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/Alexa.DoNotDisturb.doNotDisturb
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントの応答不可の設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

true

応答本文のプロパティ

説明

ブール値

指定されたエンドポイントの応答不可設定の現在値。
trueの場合、応答不可がオンになっています。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

errorSuppressionの設定を取得する

指定されたエンドポイントでAlexaが抑制するエラーのリストを取得します。この設定は、エラーが発生した場合にデバイスでオーディオによるエラーの合図(短い特徴的なサウンドなど)を再生するかどうかを制御します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.errorSuppression
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントのエラー抑制の設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

["CONNECTIVITY"]

応答本文のプロパティ

説明

文字列の配列

指定されたエンドポイントの抑制されるエラーのリスト。
有効な値は CONNECTIVITYです。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

FollowUpの設定を取得する

指定されたエンドポイントの会話継続モードの設定を取得します。この設定を有効にすると、ユーザーがウェイクワードを言わなくても、Alexaがユーザーから続けてリクエストを聞き取ることができるようになります。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.FollowUp.mode
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントの会話継続モードの設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

true

応答本文のプロパティ

説明

ブール値

指定されたエンドポイントの会話継続モード設定の現在値。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

localesの設定を取得する

指定されたエンドポイントの優先ロケールを取得します。Alexa搭載デバイスの場合、この設定により、Alexaが理解して応答に使用する言語が制御されます。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/System.locales
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントのロケールのリストが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

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

応答本文のプロパティ

説明

文字列の配列

最大2つのロケール文字列を含むリスト。
リストの最初の要素が優先ロケールです。
有効な値はar-SAde-DEen-AUen-CAen-GBen-INen-USes-ESes-MXes-USfr-CAfr-FRhi-INit-ITja-JPnl-NLpt-BRです。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

Magnifierの設定を取得する

指定されたエンドポイントの拡大鏡の設定を取得します。この設定により、ユーザーは画面付きAlexa搭載デバイス上で項目を拡大して読みやすくすることができます。

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

Healthcare Hospitality Senior Living Core

米国

米国、カナダ、イタリア、ドイツ、スペイン、日本

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/Accessibility.Display.Magnifier.enablement
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントの拡大鏡の設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

"ENABLED"

応答本文のプロパティ

説明

文字列

指定されたエンドポイントの拡大鏡設定の現在値。
有効な値は DISABLEDENABLEDです。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

maximumVolumeLimitの設定を取得する

指定されたエンドポイントの最大音量の上限設定を取得します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.maximumVolumeLimit
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントの最大音量の上限設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

90

応答本文のプロパティ

説明

整数

指定されたエンドポイントの最大音量の上限設定の現在値。
有効な値は 0~100です。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

setupModePrivilegesの設定を取得する

指定されたエンドポイントのセットアップモード権限のリストを取得します。この設定は、ユーザーがセットアップモードのプロセス(アクションボタンの長押しなど)を使用してデバイスを設定モードにできるかどうかを制御します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.setupModePrivileges
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントのセットアップモード権限のリストが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

 ["ALL_SETTINGS"]

応答本文のプロパティ

説明

文字列の配列

指定されたエンドポイントの現在のセットアップモード権限のリスト。空のリストは、エンドポイントのセットアップモードが無効であることを示します。
有効な値は ALL_SETTINGSです。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

speakingRateの設定を取得する

指定されたエンドポイントの話す速度の設定を取得します。この設定により、Alexa搭載デバイスでのAlexaの音声出力を遅くしたり速くしたりして希望の速度にすることができます。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/SpeechSynthesizer.speakingRate
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントの話す速度の設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

0.75

応答本文のプロパティ

説明

数値

指定されたエンドポイントの話す速度の設定の現在値。
デフォルト値は 1です。
有効な値は 0.750.8511.251.51.752です。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

speechConfirmationの設定を取得する

指定されたエンドポイントのリクエスト終了時のサウンド設定を取得します。この設定により、ユーザーは、Alexaへのリクエストを言い終えたときに、短い信号音が再生されるようにするかどうかを指定できます。信号音は、Alexaがリクエストの聞き取りと解釈を終了したことを示します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.speechConfirmation
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントのリクエスト終了時のサウンド設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

"NONE"

応答本文のプロパティ

説明

文字列

指定されたエンドポイントのリクエスト終了時の音声認識確認設定の現在値。
有効な値は NONETONEです。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

temperatureUnitの設定を取得する

指定されたエンドポイントの温度単位の設定を取得します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/System.temperatureUnit
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントの温度単位の設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

"FAHRENHEIT"

応答本文のプロパティ

説明

文字列

指定されたエンドポイントの温度単位設定の現在値。
有効な値は CELSIUSFAHRENHEITです。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

timeFormatの設定を取得する

指定されたエンドポイントの時計の時刻形式設定を取得します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/Alexa.DataFormat.Time.timeFormat
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントの時計の時刻形式設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

"24_HOURS"

応答本文のプロパティ

説明

文字列

指定されたエンドポイントの時計の時刻形式設定の現在値。
有効な値は 12_HOURS24_HOURSです。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

timeZoneの設定を取得する

指定されたエンドポイントのタイムゾーンの設定を取得します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/System.timeZone
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントのタイムゾーンの設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

"America/Los_Angeles"

応答本文のプロパティ

説明

文字列

指定されたエンドポイントの現在のタイムゾーン設定。
Olsonタイムゾーン形式で表します。詳細については、Time Zone Databaseを参照してください。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

wakeWordConfirmationの設定を取得する

指定されたエンドポイントのリクエスト開始時のウェイクワード確認設定を取得します。この設定により、Alexaがウェイクワードを検出したときに、視覚的な表示だけでなく信号音が再生されるようにするかどうかを指定できます。信号音は、Alexaがリクエストの聞き取りと解釈を開始したことを示します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWordConfirmation
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントのリクエスト開始時のウェイクワード確認設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

"NONE"

応答本文のプロパティ

説明

文字列

指定されたエンドポイントのリクエスト開始時のウェイクワード確認設定の現在値。
有効な値は NONETONEです。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

wakeWordsの設定を取得する

指定されたエンドポイントで有効になっているウェイクワードのリストを取得します。この設定により、ユーザーがAlexaの起動に使用できる代替のウェイクワードのリストを指定できます。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を取得するには、/v2/endpoints/{endpointId}/settingsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWords
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のプロパティ

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKと共に、指定されたエンドポイントのウェイクワードの設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

["ALEXA"]

応答本文のプロパティ

説明

文字列の配列

指定されたエンドポイントのウェイクワード設定の現在値。現時点では、リストに含めることができるエントリは1つだけです。
すべてのデバイスとロケールですべてのウェイクワードがサポートされるとは限りません。フランス(fr-FR)では、COMPUTERはサポートされません。
有効な値は ALEXAAMAZONCOMPUTERECHOです。

HTTPステータスコード

ステータス 説明

200 OK

指定されたエンドポイントの設定の現在値が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

addressを設定する

住所をエンドポイントの所在地に設定します。Alexaは、ローカル検索や天気などの機能でこの設定を使用します。詳細については、所在地情報を使用してスキルを拡張するを参照してください。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

エンドポイントの住所を作成するには、/v2/endpoints/{endpointId}/settingsリソースに対してPOSTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

POST /v2/endpoints/{endpointId}/settings/address
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

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

リクエスト本文のプロパティ

プロパティ 説明 必須

address

指定されたエンドポイントの住所。

Addressオブジェクト

応答

正常に完了すると、HTTP 201 Createdと共に、デバイスの住所が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

以下は、アドレス作成の正常な応答の例です。

住所検索で見つかった住所がリクエストで指定された住所と異なる場合、応答には住所候補が含まれます。以下は、郵便番号がリクエスト内の郵便番号と異なる場合の例です。

リクエストの必須パラメーターが不足しているか、形式が正しくない場合、応答には住所エラーが含まれます。以下は、応答コードがHTTP 400 Bad Requestの場合の例です。

応答本文のプロパティ

プロパティ 説明

address

指定されたエンドポイントの住所。成功時に含まれます。

Addressオブジェクト

addressSuggestions

(オプション)信頼度の高い順に並べた住所候補のリスト。Status 400 Bad Requestの場合に含まれます。

Addressオブジェクトの配列

addressErrors

(オプション)住所エラーのリスト。Status 400 Bad Requestの場合に含まれます。

オブジェクトの配列

addressErrors.code

必須の住所プロパティが不足しているか、住所プロパティが無効であるかを示すエラーコード。要素名はelementプロパティで指定されます。
有効な値は ELEMENT_REQUIREDELEMENT_INVALIDです。

文字列

addressErrors.Subcode

住所プロパティが無効である理由に関する追加情報。
詳細については、住所のsubCodeの値を参照してください。
有効な値は ADDRESS_PRIMARY_RANGE_MISSING_OR_INVALIDADDRESS_STREET_INCOMPLETEADDRESS_LINES_JUNK_DATAADDRESS_FIELD_LENGTH_HIGHADDRESS_CITY_INVALIDADDRESS_COUNTY_INVALIDADDRESS_STATE_INVALIDADDRESS_ZIP_INVALIDADDRESS_STREET_NOT_FOUNDADDRESS_MULTIBYTE_CHARACTERSADDRESS_DOOR_LEVEL_INFO_MISSINGFIELD_EMPTYです。

文字列

addressErrors.message

読み取り可能なエラーメッセージ。
デバッグの目的でのみ使用します。

文字列

addressErrors.element

エラーになっている住所プロパティ。
詳細については、住所のelementの値を参照してください。
有効な値は ADDRESS_1ADDRESS_2ADDRESS_3STREET_NAMEBUILDING_NUMBERCOMPLEMENTNEIGHBORHOODCITYSTATECOUNTRYZIPCOUNTYCOUNTRY_CODEです。

文字列

HTTPステータスコード

ステータス 説明

201 Created

指定されたエンドポイントの住所の設定が応答本文に含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

AlexaCaptionsの設定を更新する

指定されたエンドポイントのAlexaキャプションの設定を更新します。

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

  • Alexaキャプション。AlexaがSpeechSynthesizerインターフェースを通じて話した内容をテキストで提示します。
  • AudioPlayerディレクティブで指定されたキャプション。

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

Healthcare Hospitality Senior Living Core

米国

米国、カナダ、イタリア、ドイツ、スペイン、日本

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Captions.AlexaCaptions.enablement
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

"ENABLED"

リクエスト本文のプロパティ

説明 必須

文字列

指定されたエンドポイントに設定するAlexaキャプションの値を指定します。
有効な値は DISABLEDENABLEDです。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

ClosedCaptionsの設定を更新する

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

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Captions.ClosedCaptions.enablement
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

"ENABLED"

リクエスト本文のプロパティ

説明 必須

文字列

指定されたエンドポイントに設定するクローズドキャプションの値を指定します。
有効な値は DISABLEDENABLEDです。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

ColorInversionの設定を更新する

指定されたエンドポイントの画面の色反転設定を更新します。この設定により、デバイスのユーザーは、画面の表示色を反転させて読みやすくすることができます。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Display.ColorInversion.enablement
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

"ENABLED"

リクエスト本文のプロパティ

説明 必須

文字列

指定されたエンドポイントに設定する色反転の値を指定します。
有効な値は DISABLEDENABLEDです。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

distanceUnitsの設定を更新する

指定されたエンドポイントの距離単位(メートル法またはヤード・ポンド法)の設定を更新します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/System.distanceUnits
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

"METRIC"

リクエスト本文のプロパティ

説明 必須

文字列

指定されたエンドポイントに設定する距離単位の値を指定します。
有効な値は IMPERIALMETRICです。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

DoNotDisturbの設定を更新する

指定されたエンドポイントの応答不可の設定を更新します。この設定により、通知やプロアクティブなエクスペリエンス(通話など)がユーザーの妨げになるのを防ぐことができます。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/Alexa.DoNotDisturb.doNotDisturb
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

true

リクエスト本文のプロパティ

説明 必須

ブール値

指定されたエンドポイントに設定する応答不可の値を指定します。
応答不可をオンにする場合はtrueに設定します。
応答不可をオフにする場合はfalseに設定します。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

errorSuppressionの設定を更新する

指定されたエンドポイントでAlexaが抑制するエラーのリストを更新します。この設定は、エラーが発生した場合にデバイスでオーディオによるエラーの合図(短い特徴的なサウンドなど)を再生するかどうかを制御します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.errorSuppression
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

["CONNECTIVITY"]

リクエスト本文のプロパティ

説明 必須

文字列の配列

指定されたエンドポイントで抑制するエラーのリスト。
有効な値は CONNECTIVITYです。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

FollowUpの設定を更新する

指定されたエンドポイントの会話継続モードの設定を更新します。この設定を有効にすると、ユーザーがウェイクワードを言わなくても、Alexaがユーザーから続けてリクエストを聞き取ることができるようになります。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.FollowUp.mode
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

false

リクエスト本文のプロパティ

説明 必須

ブール値

指定されたエンドポイントに設定する会話継続モードの値を指定します。
会話継続モードをオンにする場合はtrueに設定します。
会話継続モードをオフにする場合はfalseに設定します。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

localesの設定を更新する

指定されたエンドポイントの優先ロケールを更新します。Alexa搭載デバイスの場合、この設定により、Alexaが理解して応答に使用する言語が制御されます。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/System.locales
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

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

リクエスト本文のプロパティ

説明 必須

文字列の配列

指定されたエンドポイントに設定するロケール。
最大2つのロケール文字列を含むリスト。リストの最初の要素が優先ロケールです。
有効な値はar-SAde-DEen-AUen-CAen-GBen-INen-USes-ESes-MXes-USfr-CAfr-FRhi-INit-ITja-JPnl-NLpt-BRです。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

Magnifierの設定を更新する

指定されたエンドポイントの拡大鏡の設定を更新します。この設定により、ユーザーは画面付きAlexa搭載デバイス上で項目を拡大して読みやすくすることができます。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/Accessibility.Display.Magnifier.enablement
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

"ENABLED"

リクエスト本文のプロパティ

説明 必須

文字列

指定されたエンドポイントに設定する拡大鏡の値を指定します。
有効な値は DISABLEDENABLEDです。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

maximumVolumeLimitの設定を更新する

指定されたエンドポイントの最大音量の上限設定を更新します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/Alexa.ManagedDevice.Settings.maximumVolumeLimit
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

95

リクエスト本文のプロパティ

説明 必須

整数

指定されたエンドポイントに設定する最大音量の上限値を指定します。
有効な値は 0~100です。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

speakingRateの設定を更新する

指定されたエンドポイントの話す速度の設定を更新します。この設定により、Alexa搭載デバイスでのAlexaの音声を調整して希望の速度にすることができます。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/SpeechSynthesizer.speakingRate
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

0.85

リクエスト本文のプロパティ

説明 必須

数値

指定されたエンドポイントに設定する話す速度の値を指定します。
デフォルト値は 1です。
有効な値は 0.750.8511.251.51.752です。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

speechConfirmationの設定を更新する

指定されたエンドポイントのリクエスト終了時のサウンド確認設定を更新します。この設定により、ユーザーは、Alexaへのリクエストを言い終えたときに、短い信号音が再生されるようにするかどうかを指定できます。信号音は、Alexaがリクエストの聞き取りと解釈を終了したことを示します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.speechConfirmation
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

"TONE"

リクエスト本文のプロパティ

説明 必須

文字列

指定されたエンドポイントに設定するリクエスト終了時の音声認識確認の値を指定します。
有効な値は NONETONEです。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

temperatureUnitの設定を更新する

指定されたエンドポイントの温度単位の設定を更新します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/System.temperatureUnit
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

"CELSIUS"

リクエスト本文のプロパティ

説明 必須

文字列

指定されたエンドポイントに設定する温度単位の値を指定します。
有効な値は CELSIUSFAHRENHEITです。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

timeFormatの設定を更新する

指定されたエンドポイントの時計の時刻形式設定を更新します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/Alexa.DataFormat.Time.timeFormat
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

"12_HOURS"

リクエスト本文のプロパティ

説明 必須

文字列

指定されたエンドポイントに設定する時計の時刻形式の値を指定します。
有効な値は 12_HOURS24_HOURSです。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

timeZoneの設定を更新する

指定されたエンドポイントのタイムゾーンの設定を更新します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/System.timeZone
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

"America/New_York"

リクエスト本文のプロパティ

説明 必須

文字列

指定されたエンドポイントに設定するタイムゾーンの値を指定します。
Olsonタイムゾーン形式で表します。詳細については、Time Zone Databaseを参照してください。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

wakeWordConfirmationの設定を更新する

指定されたエンドポイントのリクエスト開始時のウェイクワード確認設定を更新します。この設定により、Alexaがウェイクワードを検出したときに、視覚的な表示だけでなく信号音が再生されるようにするかどうかを指定できます。信号音は、Alexaがリクエストの聞き取りと解釈を開始したことを示します。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWordConfirmation
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

"TONE"

リクエスト本文のプロパティ

説明 必須

文字列

指定されたエンドポイントに設定するリクエスト開始時のウェイクワード確認の値を指定します。
有効な値は NONETONEです。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

wakeWordsの設定を更新する

指定されたエンドポイントで有効にするウェイクワードのリストを更新します。この設定により、ユーザーがAlexaの起動に使用できる代替のウェイクワードのリストを指定できます。

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

Healthcare Hospitality Senior Living Core

米国

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

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

米国

リクエスト

設定を更新するには、/v2/endpoints/{endpointId}/settingsリソースに対してPUTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

PUT /v2/endpoints/{endpointId}/settings/SpeechRecognizer.wakeWords
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストパスとリクエストヘッダーのパラメーター

パラメーター 位置 説明 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier(ACI)形式で表します。

文字列

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

リクエスト本文の例

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

["ECHO"]

リクエスト本文のプロパティ

説明 必須

文字列

指定されたエンドポイントに設定するウェイクワードの値を指定します。現時点では、リストに含めることができるエントリは1つだけです。
すべてのデバイスとロケールですべてのウェイクワードがサポートされるとは限りません。フランス(fr-FR)では、COMPUTERはサポートされません。
有効な値は ALEXAAMAZONCOMPUTERECHOです。

応答

正常に完了すると、HTTP 204 No Contentが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 No content

設定が正常に適用されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

405 Method Not Allowed

指定された設定をリソースがサポートしていないことを示します。

429 Too Many Requests

許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

オブジェクトの定義

エンドポイント設定APIでは、以下のオブジェクトとプロパティ値が定義されています。

Address

Addressオブジェクトは、指定されたエンドポイントデバイスの所在地を表します。

プロパティ 説明 必須

addressLine1

住所の1行目。
このプロパティは空の文字列に設定できます。

文字列

addressLine2

住所の2行目。
このプロパティは空の文字列に設定できます。

文字列

addressLine3

住所の3行目。
このプロパティは空の文字列に設定できます。

文字列

city

市区町村名。

文字列

stateOrRegion

エンドポイントに関連付けられている州、省、地域の省略形。
米国以外の国では、このプロパティは空の文字列に設定できます。

文字列

districtOrCounty

エンドポイントに関連付けられている地区または郡。
米国以外の国では、このプロパティは空の文字列に設定できます。

文字列

postalCode

郵便番号。

文字列

countryCode

2文字の国/リージョンコード。

文字列

住所のsubCodeの値

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

必須フィールドが入力されていません。

住所のelementの値

次の表は、住所のelementプロパティの有効な値の一覧です。

説明

ADDRESS_1

住所の1行目。

ADDRESS_2

住所の2行目(ある場合)。

ADDRESS_3

住所の3行目(ある場合)。

STREET_NAME

住所に含まれている通りの名前。

BUILDING_NUMBER

建物番号。

COMPLEMENT

アパートの部屋番号など、建物内のユニットの番号。

NEIGHBORHOOD

市内の小区域を表します。

CITY

住所が属している市や地方自治体。

STATE

住所が属している米国の州または領土。

COUNTRY

住所が属している国。

ZIP

住所の5桁または9桁の郵便番号。

COUNTY

住所が属している郡。

COUNTRY_CODE

住所の国コード。

Errorオブジェクト

Errorオブジェクトは、エラーが発生したときに応答に含まれるエラーのタイプとメッセージを定義します。

以下は、エラータイプとメッセージを含む応答本文の例です。

{
    "type": "ENDPOINT_UNREACHABLE",
    "message": "The endpoint is offline or unreachable."
}
プロパティ 説明

type

発生したエラーのタイプ。
具体的なエラータイプについては、各操作のHTTPステータスコードの表を参照してください。

文字列

message

読み取り可能なエラーメッセージ。エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。

文字列


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

最終更新日: 2024 年 11 月 20 日