エンドポイント設定REST APIリファレンス
エンドポイント設定REST APIを使用すると、デバイスの住所、タイムゾーン、応答不可の設定など、Alexaコネクテッドエンドポイントの設定を表示および更新できます。Alexa Smart Properties(ASP)では、エンドポイントは、Amazon EchoデバイスやAlexaコネクテッド照明など、ASPのゲストや居住者が操作できるAlexaコネクテッドデバイスまたはコンポーネントを表します。Amazonビジネスアカウントで所有されているデバイスの設定を表示および変更する場合は、エンドポイント設定APIとエンドポイントREST APIを併せて使用します。
APIエンドポイント
組織が所在する国に応じて、リクエストヘッダーのHost
パラメーターを、以下のいずれかのAPIエンドポイントに設定してください。
国 | エンドポイント |
---|---|
カナダ、米国 |
|
ドイツ、スペイン、フランス、イタリア、英国 |
|
日本 |
|
認証
すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値にはLogin with Amazon(LWA)から取得したアクセストークンが入ります。詳細については、APIアクセスを管理するを参照してください。
操作
エンドポイント設定APIには、以下の操作が用意されています。
操作 | HTTPメソッドとURI |
---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
複数の設定を取得する
指定されたエンドポイントの複数の設定の現在値を取得します。
この操作は以下の国で使用できます。
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
クエリ |
設定の名前のカンマ区切りリスト。 |
文字列 |
◯ |
|
クエリ |
応答で返される結果の最大数。 |
整数 |
✕ |
|
クエリ |
前回の応答で受け取ったトークン。 |
文字列 |
✕ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、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": {}
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
リクエストされた設定値の順不同のリスト。 |
オブジェクトの配列 |
|
リクエストで指定した設定の名前。 |
文字列 |
|
設定の値。 |
文字列 |
|
(オプション)発生したエラーのリスト。 |
オブジェクトの配列 |
|
リクエストで指定した設定の名前。 |
文字列 |
|
文字列 | |
|
エラーを識別します。 |
文字列 |
|
読み取り可能なエラーメッセージ。 |
文字列 |
|
(オプション) |
オブジェクト |
|
次に返される設定値のセットを識別します。 |
文字列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントのリクエストされた設定の現在値が応答本文に含まれます。個々の設定が失敗した場合、応答には |
|
設定は存在していますが、設定値が空です。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントの設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
{
"address": {
"addressLine1": "221 Baker Ave",
"addressLine2": "",
"addressLine3": "",
"city": "Sunnyvale",
"stateOrRegion": "CA",
"districtOrCounty": "",
"postalCode": "94085",
"countryCode": "US"
}
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
指定されたエンドポイントの住所。 |
Addressオブジェクト |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの住所の設定が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
AlexaCaptionsの設定を取得する
指定されたエンドポイントのAlexaキャプションの設定を取得します。
この設定は、マルチメディアデバイスで以下の情報を表示するかどうかを制御します。
- Alexaキャプション。Alexaが
SpeechSynthesizer
インターフェースを通じて話した内容をテキストで提示します。 - AudioPlayerディレクティブで指定されたキャプション。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、カナダ、フランス、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
設定を取得するには、/v2/endpoints/{endpointId}/settings
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントのAlexaキャプションの設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
"ENABLED"
応答本文のプロパティ
型 | 説明 |
---|---|
文字列 |
指定されたエンドポイントのAlexaキャプション設定の現在値。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
ClosedCaptionsの設定を取得する
指定されたエンドポイントのクローズドキャプションの設定を取得します。この設定は、マルチメディアデバイスでビデオコンテンツのクローズドキャプションを表示するかどうかを制御します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、カナダ、フランス、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
設定を取得するには、/v2/endpoints/{endpointId}/settings
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントのクローズドキャプションの設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
"ENABLED"
応答本文のプロパティ
型 | 説明 |
---|---|
文字列 |
指定されたエンドポイントのクローズドキャプション設定の現在値。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントの画面の色反転設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
"ENABLED"
応答本文のプロパティ
型 | 説明 |
---|---|
文字列 |
指定されたエンドポイントの色反転設定の現在値。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントの距離単位の設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
"METRIC"
応答本文のプロパティ
型 | 説明 |
---|---|
文字列 |
指定されたエンドポイントの距離単位設定の現在値。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
DoNotDisturbの設定を取得する
指定されたエンドポイントの応答不可の設定を取得します。この設定により、通知やプロアクティブなエクスペリエンス(通話など)がユーザーの妨げになるのを防ぐことができます。
DoNotDisturb
モードの場合、プロアクティブサジェスチョンのキャンペーンは、ユーザーが直近でAlexaと対話した場合にのみ表示されます。Alexaとの対話がない状態が数分間続くと、デバイスは時計の表示に戻ります。
この操作は以下の国で使用できます。
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントの応答不可の設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
true
応答本文のプロパティ
型 | 説明 |
---|---|
ブール値 |
指定されたエンドポイントの応答不可設定の現在値。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントのエラー抑制の設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
["CONNECTIVITY"]
応答本文のプロパティ
型 | 説明 |
---|---|
文字列の配列 |
指定されたエンドポイントの抑制されるエラーのリスト。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントの会話継続モードの設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
true
応答本文のプロパティ
型 | 説明 |
---|---|
ブール値 |
指定されたエンドポイントの会話継続モード設定の現在値。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントのロケールのリストが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
["en-US", "es-US"]
応答本文のプロパティ
型 | 説明 |
---|---|
文字列の配列 |
最大2つのロケール文字列を含むリスト。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントの拡大鏡の設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
"ENABLED"
応答本文のプロパティ
型 | 説明 |
---|---|
文字列 |
指定されたエンドポイントの拡大鏡設定の現在値。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントの最大音量の上限設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
90
応答本文のプロパティ
型 | 説明 |
---|---|
整数 |
指定されたエンドポイントの最大音量の上限設定の現在値。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントのセットアップモード権限のリストが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
["ALL_SETTINGS"]
応答本文のプロパティ
型 | 説明 |
---|---|
文字列の配列 |
指定されたエンドポイントの現在のセットアップモード権限のリスト。空のリストは、エンドポイントのセットアップモードが無効であることを示します。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントの話す速度の設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
0.75
応答本文のプロパティ
型 | 説明 |
---|---|
数値 |
指定されたエンドポイントの話す速度の設定の現在値。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントのリクエスト終了時のサウンド設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
"NONE"
応答本文のプロパティ
型 | 説明 |
---|---|
文字列 |
指定されたエンドポイントのリクエスト終了時の音声認識確認設定の現在値。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントの温度単位の設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
"FAHRENHEIT"
応答本文のプロパティ
型 | 説明 |
---|---|
文字列 |
指定されたエンドポイントの温度単位設定の現在値。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントの時計の時刻形式設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
"24_HOURS"
応答本文のプロパティ
型 | 説明 |
---|---|
文字列 |
指定されたエンドポイントの時計の時刻形式設定の現在値。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントのタイムゾーンの設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
"America/Los_Angeles"
応答本文のプロパティ
型 | 説明 |
---|---|
文字列 |
指定されたエンドポイントの現在のタイムゾーン設定。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントのリクエスト開始時のウェイクワード確認設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
"NONE"
応答本文のプロパティ
型 | 説明 |
---|---|
文字列 |
指定されたエンドポイントのリクエスト開始時のウェイクワード確認設定の現在値。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたエンドポイントのウェイクワードの設定が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
["ALEXA"]
応答本文のプロパティ
型 | 説明 |
---|---|
文字列の配列 |
指定されたエンドポイントのウェイクワード設定の現在値。現時点では、リストに含めることができるエントリは1つだけです。 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの設定の現在値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
{
"address": {
"addressLine1": "221 Baker Ave",
"addressLine2": "",
"addressLine3": "",
"city": "Sunnyvale",
"stateOrRegion": "CA",
"districtOrCounty": "",
"postalCode": "94085",
"countryCode": "US"
}
}
リクエスト本文のプロパティ
プロパティ | 説明 | 型 | 必須 |
---|---|---|---|
|
指定されたエンドポイントの住所。 |
Addressオブジェクト |
◯ |
応答
正常に完了すると、HTTP 201 Created
と共に、デバイスの住所が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
以下は、アドレス作成の正常な応答の例です。
住所検索で見つかった住所がリクエストで指定された住所と異なる場合、応答には住所候補が含まれます。以下は、郵便番号がリクエスト内の郵便番号と異なる場合の例です。
リクエストの必須パラメーターが不足しているか、形式が正しくない場合、応答には住所エラーが含まれます。以下は、応答コードがHTTP 400 Bad Request
の場合の例です。
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
指定されたエンドポイントの住所。成功時に含まれます。 |
Addressオブジェクト |
|
(オプション)信頼度の高い順に並べた住所候補のリスト。 |
Addressオブジェクトの配列 |
|
(オプション)住所エラーのリスト。 |
オブジェクトの配列 |
|
必須の住所プロパティが不足しているか、住所プロパティが無効であるかを示すエラーコード。要素名は |
文字列 |
|
住所プロパティが無効である理由に関する追加情報。 |
文字列 |
|
読み取り可能なエラーメッセージ。 |
文字列 |
|
エラーになっている住所プロパティ。 |
文字列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントの住所の設定が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
AlexaCaptionsの設定を更新する
指定されたエンドポイントのAlexaキャプションの設定を更新します。
この設定は、マルチメディアデバイスで以下の情報を表示するかどうかを制御します。
- Alexaキャプション。Alexaが
SpeechSynthesizer
インターフェースを通じて話した内容をテキストで提示します。 - AudioPlayerディレクティブで指定されたキャプション。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、カナダ、フランス、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
設定を更新するには、/v2/endpoints/{endpointId}/settings
リソースに対してPUT
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
文字列 |
指定されたエンドポイントに設定するAlexaキャプションの値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
ClosedCaptionsの設定を更新する
指定されたエンドポイントのクローズドキャプションの設定を更新します。この設定は、マルチメディアデバイスでビデオコンテンツのクローズドキャプションを表示するかどうかを制御します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、カナダ、イタリア、ドイツ、日本 |
米国、英国、カナダ、フランス、イタリア、ドイツ、日本 |
米国 |
リクエスト
設定を更新するには、/v2/endpoints/{endpointId}/settings
リソースに対してPUT
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
文字列 |
指定されたエンドポイントに設定するクローズドキャプションの値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
"ENABLED"
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
文字列 |
指定されたエンドポイントに設定する色反転の値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
"METRIC"
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
文字列 |
指定されたエンドポイントに設定する距離単位の値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
DoNotDisturbの設定を更新する
指定されたエンドポイントの応答不可の設定を更新します。この設定により、通知やプロアクティブなエクスペリエンス(通話など)がユーザーの妨げになるのを防ぐことができます。
DoNotDisturb
モードの場合、プロアクティブサジェスチョンのキャンペーンは、ユーザーが直近でAlexaと対話した場合にのみ表示されます。Alexaとの対話がない状態が数分間続くと、デバイスは時計の表示に戻ります。
この操作は以下の国で使用できます。
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
true
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
ブール値 |
指定されたエンドポイントに設定する応答不可の値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
["CONNECTIVITY"]
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
文字列の配列 |
指定されたエンドポイントで抑制するエラーのリスト。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
false
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
ブール値 |
指定されたエンドポイントに設定する会話継続モードの値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
["en-US", "fr-FR"]
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
文字列の配列 |
指定されたエンドポイントに設定するロケール。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
"ENABLED"
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
文字列 |
指定されたエンドポイントに設定する拡大鏡の値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
95
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
整数 |
指定されたエンドポイントに設定する最大音量の上限値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
0.85
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
数値 |
指定されたエンドポイントに設定する話す速度の値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
"TONE"
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
文字列 |
指定されたエンドポイントに設定するリクエスト終了時の音声認識確認の値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
"CELSIUS"
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
文字列 |
指定されたエンドポイントに設定する温度単位の値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
"12_HOURS"
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
文字列 |
指定されたエンドポイントに設定する時計の時刻形式の値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
"America/New_York"
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
文字列 |
指定されたエンドポイントに設定するタイムゾーンの値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
"TONE"
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
文字列 |
指定されたエンドポイントに設定するリクエスト開始時のウェイクワード確認の値を指定します。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
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}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
["ECHO"]
リクエスト本文のプロパティ
型 | 説明 | 必須 |
---|---|---|
文字列 |
指定されたエンドポイントに設定するウェイクワードの値を指定します。現時点では、リストに含めることができるエントリは1つだけです。 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
設定が正常に適用されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
指定された設定をリソースがサポートしていないことを示します。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
オブジェクトの定義
エンドポイント設定APIでは、以下のオブジェクトとプロパティ値が定義されています。
Address
Address
オブジェクトは、指定されたエンドポイントデバイスの所在地を表します。
プロパティ | 説明 | 型 | 必須 |
---|---|---|---|
|
住所の1行目。 |
文字列 |
◯ |
|
住所の2行目。 |
文字列 |
◯ |
|
住所の3行目。 |
文字列 |
◯ |
|
市区町村名。 |
文字列 |
◯ |
|
エンドポイントに関連付けられている州、省、地域の省略形。 |
文字列 |
◯ |
|
エンドポイントに関連付けられている地区または郡。 |
文字列 |
◯ |
|
郵便番号。 |
文字列 |
◯ |
|
2文字の国/リージョンコード。 |
文字列 |
◯ |
住所のsubCodeの値
subCode
プロパティは、住所要素が無効である理由に関する追加情報を提供します。次の表は、subCode
の値の一覧です。
値 | 説明 |
---|---|
|
住所の番号が正しくありません。 |
|
通りの名前が完全ではありません。 |
|
住所の行のフィールドに不要なデータが含まれています。 |
|
住所フィールドの長さが許容範囲を超えています。 |
|
指定された州に該当する名前の市がありません。 |
|
指定された郡が正しくありません。 |
|
指定された州が正しくありません。 |
|
指定された州、市、通りに対して、指定された郵便番号が正しくありません。 |
|
指定された市に該当する通りがありません。 |
|
フィールドにマルチバイト文字が含まれています。 |
|
住所に各戸レベルの情報がありません。 |
|
必須フィールドが入力されていません。 |
住所のelementの値
次の表は、住所のelement
プロパティの有効な値の一覧です。
値 | 説明 |
---|---|
|
住所の1行目。 |
|
住所の2行目(ある場合)。 |
|
住所の3行目(ある場合)。 |
|
住所に含まれている通りの名前。 |
|
建物番号。 |
|
アパートの部屋番号など、建物内のユニットの番号。 |
|
市内の小区域を表します。 |
|
住所が属している市や地方自治体。 |
|
住所が属している米国の州または領土。 |
|
住所が属している国。 |
|
住所の5桁または9桁の郵便番号。 |
|
住所が属している郡。 |
|
住所の国コード。 |
Errorオブジェクト
Error
オブジェクトは、エラーが発生したときに応答に含まれるエラーのタイプとメッセージを定義します。
以下は、エラータイプとメッセージを含む応答本文の例です。
{
"type": "ENDPOINT_UNREACHABLE",
"message": "The endpoint is offline or unreachable."
}
プロパティ | 説明 | 型 |
---|---|---|
|
発生したエラーのタイプ。 |
文字列 |
|
読み取り可能なエラーメッセージ。エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。 |
文字列 |
関連トピック
- Alexa Smart Properties REST APIリファレンス
- エンドポイントREST APIリファレンス
- エンドポイント機能REST APIリファレンス
- エンドポイントWi-Fi管理REST APIリファレンス
最終更新日: 2024 年 11 月 20 日