エンドポイント機能REST APIリファレンス
エンドポイント機能REST APIを使用すると、スマートホーム照明の電源状態など、Alexaコネクテッドエンドポイントのプロパティを表示および更新できます。Amazonビジネスアカウントで所有されているデバイスの設定を表示および更新する場合は、エンドポイント機能APIとエンドポイントREST APIを併せて使用します。
APIエンドポイント
組織が所在する国に応じて、リクエストヘッダーのHost
パラメーターを、以下のいずれかのAPIエンドポイントに設定してください。
国 | エンドポイント |
---|---|
カナダ、米国 |
|
ドイツ、スペイン、フランス、イタリア、英国 |
|
日本 |
|
認証
すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値にはLogin with Amazon(LWA)から取得したアクセストークンが入ります。詳細については、APIアクセスを管理するを参照してください。
操作
エンドポイント機能APIには、以下の操作が用意されています。
操作 | HTTPメソッドとURI |
---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Bluetoothのプロパティを取得する
指定されたエンドポイントのBluetoothのプロパティを取得します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
なし |
米国、英国、フランス、カナダ、イタリア、ドイツ、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、日本 |
なし |
リクエスト
Bluetoothのプロパティを取得するには、features/bluetooth
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v2/endpoints/{endpointId}/features/bluetooth
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のパラメーター
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、Bluetoothのプロパティが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
以下は、応答の例です。
{
"operations": [
{
"name": "unpair",
"path": "/v2/endpoints/{endpointId}/features/bluetooth/unpair"
}
]
}
応答本文のパラメーター
パラメーター | 説明 | 型 |
---|---|---|
|
エンドポイントのBluetoothプロパティのリスト。 |
オブジェクトの配列 |
|
プロパティの名前。 |
文字列 |
|
プロパティのタイプ。 |
文字列 |
|
(オプション)発生したエラーについての説明。 |
Errorオブジェクト |
|
この機能とエンドポイントで使用可能な更新操作のリスト。 |
Operationオブジェクトの配列 |
|
呼び出し元にアクセスできる設定データ。 |
設定オブジェクトのリスト |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
リクエストされたプロパティの現在の値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
輝度を取得する
指定されたエンドポイントの輝度レベルを取得します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
輝度レベルを取得するには、features/brightness
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v2/endpoints/{endpointId}/features/brightness
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、現在の輝度レベルが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
{
"properties": [{
"name": "brightness",
"type": "RETRIEVABLE",
"value": {
"value": 50
},
"timeOfSample": "2023-07-03T10:20:50.52Z"
}],
"operations": [
{
"name": "setBrightness",
"path": "/v2/endpoints/{id}/features/brightness/setBrightness"
},
{
"name": "adjustBrightness",
"path": "/v2/endpoints/{id}/features/brightness/adjustBrightness"
}
]
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
エンドポイントの輝度プロパティのリスト。 |
オブジェクトの配列 |
|
プロパティの名前。 |
文字列 |
|
プロパティのタイプ。 |
文字列 |
|
輝度のプロパティ。 |
オブジェクト |
|
エンドポイントの現在の輝度レベル。 |
整数 |
|
エンドポイントが状態変更を検出した時刻。 |
文字列 |
|
(オプション)発生したエラーについての説明。 |
Errorオブジェクト |
|
この機能とエンドポイントで使用可能な更新操作のリスト。 |
Operationオブジェクトの配列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
リクエストされたプロパティの現在の値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
色を取得する
指定されたエンドポイントの色相、彩度、輝度を取得します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
色を取得するには、features/color
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v2/endpoints/{endpointId}/features/color
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、エンドポイントの現在の色相、彩度、輝度が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
{
"properties": [{
"name": "color",
"type": "RETRIEVABLE",
"value": {
"hue": 20,
"saturation": 0.5,
"brightness": 0.7
},
"timeOfSample": "2023-07-03T10:20:50.52Z"
}],
"operations": [
{
"name": "setColor",
"path": "/v2/endpoints/{endpointId}/features/color/setColor"
}
]
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
エンドポイントの色プロパティのリスト。 |
オブジェクトの配列 |
|
プロパティの名前。 |
文字列 |
|
プロパティのタイプ。 |
文字列 |
|
エンドポイントの現在の色。 |
Colorオブジェクト |
|
色の現在の色相値。 |
整数 |
|
色の現在の彩度レベル。 |
浮動小数点 |
|
現在の輝度。 |
浮動小数点 |
|
エンドポイントが状態変更を検出した時刻。 |
文字列 |
|
(オプション)発生したエラーについての説明。 |
Errorオブジェクト |
|
この機能とエンドポイントで使用可能な更新操作のリスト。 |
Operationオブジェクトの配列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
リクエストされたプロパティの現在の値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
色温度を取得する
白色光を調整可能なエンドポイント(電球など)の色温度を取得します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
色温度を取得するには、features/colorTemperature
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v2/endpoints/{endpointId}/features/colorTemperature
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、現在の色温度が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
{
"properties": [{
"name": "colorTemperatureInKelvin",
"type": "RETRIEVABLE",
"value": {
"value": 2700
},
"timeOfSample": "2023-07-03T10:20:50.52Z"
}],
"operations": [
{
"name": "setColorTemperature",
"path": "/v2/endpoints/{id}/features/colorTemperature/setColorTemperature"
},
{
"name": "increaseColorTemperature",
"path": "/v2/endpoints/{id}/features/colorTemperature/increaseColorTemperature"
},
{
"name": "decreaseColorTemperature",
"path": "/v2/endpoints/{id}/features/colorTemperature/decreaseColorTemperature"
}
]
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
エンドポイントの色温度プロパティのリスト。 |
オブジェクトの配列 |
|
プロパティの名前。 |
文字列 |
|
プロパティのタイプ。 |
文字列 |
|
色のプロパティ。 |
オブジェクト |
|
エンドポイントの現在の色温度(ケルビン単位)。白の色調の詳細については、色温度の値を参照してください。 |
整数 |
|
エンドポイントが状態変更を検出した時刻。 |
文字列 |
|
(オプション)発生したエラーについての説明。 |
Errorオブジェクト |
|
この機能とエンドポイントで使用可能な更新操作のリスト。 |
Operationオブジェクトの配列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
リクエストされたプロパティの現在の値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
接続ステータスを取得する
指定されたエンドポイントの接続ステータスを取得します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
接続ステータスを取得するには、features/connectivity
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v2/endpoints/{endpointId}/features/connectivity
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、エンドポイントの接続ステータスが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
{
"properties": [{
"name": "reachability",
"type": "RETRIEVABLE",
"value": {
"value": "OK"
},
"timeOfSample": "2023-07-03T10:20:50.52Z"
}]
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
エンドポイントの輝度プロパティのリスト。 |
オブジェクトの配列 |
|
プロパティの名前。 |
文字列 |
|
プロパティのタイプ。 |
文字列 |
|
接続プロパティ。 |
オブジェクト |
|
エンドポイントの現在の接続ステータス。有効な値は次のとおりです。
|
文字列 |
|
エンドポイントが状態変更を検出した時刻。 |
文字列 |
|
(オプション)発生したエラーについての説明。 |
Errorオブジェクト |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
リクエストされたプロパティの現在の値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
電源状態を取得する
指定されたエンドポイントの電源のオン/オフ状態を確認します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
電源状態を取得するには、features/power
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v2/endpoints/{endpointId}/features/power
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、エンドポイントの電源状態が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
{
"properties": [{
"name": "powerState",
"type": "RETRIEVABLE",
"value": {
"value": "ON"
},
"timeOfSample": "2023-07-03T10:20:50.52Z"
}],
"operations": [
{
"name": "turnOn",
"path": "/v2/endpoints/{endpointID}/features/power/turnOn"
},
{
"name": "turnOff",
"path": "/v2/endpoints/{endpointID}/features/power/turnOff"
}
]
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
エンドポイントの電源プロパティのリスト。 |
オブジェクトの配列 |
|
プロパティの名前。 |
文字列 |
|
プロパティのタイプ。 |
文字列 |
|
電源のプロパティ。 |
オブジェクト |
|
エンドポイントの現在の電源状態。有効な値は |
文字列 |
|
エンドポイントが状態変更を検出した時刻。 |
文字列 |
|
(オプション)発生したエラーについての説明。 |
Errorオブジェクト |
|
この機能とエンドポイントで使用可能な更新操作のリスト。 |
Operationオブジェクトの配列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
リクエストされたプロパティの現在の値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
スピーカーのプロパティを取得する
指定されたエンドポイントのスピーカーのプロパティを取得します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
スピーカーのプロパティを取得するには、features/speaker
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v2/endpoints/{endpointId}/features/speaker
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、エンドポイントのスピーカーのプロパティが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
{
"properties": [{
"name": "volume",
"type": "RETRIEVABLE",
"value": {
"value": "42"
},
"timeOfSample": "2023-07-03T10:20:50.52Z"
}],
"operations": [
{
"name": "setVolume",
"path": "/v2/endpoints/<id>/features/speaker/setVolume"
},
{
"name": "adjustVolume",
"path": "/v2/endpoints/<id>/features/speaker/adjustVolume"
}
]
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
エンドポイントのスピーカープロパティのリスト。 |
オブジェクトの配列 |
|
プロパティの名前。 |
文字列 |
|
プロパティのタイプ。 |
文字列 |
|
スピーカーのプロパティ。 |
オブジェクト |
|
現在の音量。有効な値は 0~100です。 |
整数 |
|
エンドポイントが状態変更を検出した時刻。 |
文字列 |
|
(オプション)発生したエラーについての説明。 |
Errorオブジェクト |
|
この機能とエンドポイントで使用可能な更新操作のリスト。 |
Operationオブジェクトの配列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
リクエストされたプロパティの現在の値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
温度センサーを取得する
指定されたエンドポイントで検出された現在の温度を取得します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
温度を取得するには、features/temperatureSensor
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v2/endpoints/{endpointId}/features/temperatureSensor
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、現在の温度が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
{
"properties": [{
"name": "thermostatMode",
"type": "RETRIEVABLE",
"value": {
"value": "HEAT"
},
"timeOfSample": "2021-03-04T17:46:42.48Z"
},
{
"name": "targetSetpoint",
"type": "RETRIEVABLE",
"value": {
"value": 68.0,
"scale": "FAHRENHEIT"
},
"timeOfSample": "2021-03-04T17:46:42.48Z"
}
],
"configuration": {
"supportedModes": [
"HEAT",
"COOL",
"AUTO",
"ECO"
]
}
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
エンドポイントのサーモスタットプロパティのリスト。 |
オブジェクトの配列 |
|
プロパティの名前。 |
文字列 |
|
プロパティのタイプ。 |
文字列 |
|
温度のプロパティ。 |
Temperatureオブジェクト |
|
エンドポイントで検出された現在の温度。 |
浮動小数点 |
|
温度の単位。 |
文字列 |
|
エンドポイントが状態変更を検出した時刻。 |
文字列 |
|
(オプション)発生したエラーについての説明。 |
Errorオブジェクト |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
リクエストされたプロパティの現在の値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
サーモスタットのプロパティを取得する
指定されたエンドポイントのサーモスタットモードと設定値を取得します。設定値が1つのサーモスタットの場合、温度設定は1つだけです。設定値が2つのサーモスタットには、上限と下限の設定値があります。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
サーモスタットのプロパティを取得するには、features/thermostat
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v2/endpoints/{endpointId}/features/thermostat
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、サーモスタットエンドポイントのサーモスタットモードと設定値が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
以下は、設定値が1つのサーモスタットのサーモスタットプロパティの例です。
以下は、設定値が2つのサーモスタットのサーモスタットプロパティの例です。
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
エンドポイントのサーモスタットプロパティのリスト。 |
オブジェクトの配列 |
|
プロパティの名前。 |
文字列 |
|
プロパティのタイプ。 |
文字列 |
|
指定されたエンドポイントのサーモスタットのプロパティ。 |
オブジェクト |
|
nameで指定されているプロパティの現在の値。 |
文字列( |
|
温度の単位。 |
文字列 |
|
エンドポイントが状態変更を検出した時刻。 |
文字列 |
|
(オプション)発生したエラーについての説明。 |
Errorオブジェクト |
|
サポートされるサーモスタットモード。 |
オブジェクト |
|
サーモスタットエンドポイントがサポートするモードのリスト。有効な値は |
文字列の配列 |
|
この機能とエンドポイントで使用可能な更新操作のリスト。 |
Operationオブジェクトの配列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
リクエストされたプロパティの現在の値が応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
Wi-Fiのインストールステータスを取得する
指定されたエンドポイントでの前回のWi-Fi設定を設定する
操作のステータスを取得します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、カナダ、英国、ドイツ、フランス、イタリア、スペイン、日本 |
米国、カナダ、英国、ドイツ、フランス、イタリア、スペイン、日本 |
米国 |
リクエスト
インストールステータスを取得するには、features/connectivity/addOrUpdateWifiConfigurations
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v2/endpoints/{endpointId}/features/connectivity/addOrUpdateWifiConfigurations/submittedOperations/{operationId}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
パス |
|
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、Wi-Fiのインストールステータスが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
{
"status": {
"value": "IN_PROGRESS"
}
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
指定されたエンドポイントに対してリクエストされたWi-Fi設定のインストールステータスを識別します。 |
オブジェクト |
|
操作ステータスの値。 |
文字列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
Wi-Fiの現在のインストールステータスが応答本文に含まれます。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
Wi-Fi設定を保存する
Wi-Fi設定を設定するでエンドポイントに割り当てるWi-Fi設定を保存します。この操作を実行するには、credential_locker::wifi_management
、alexa::enterprise:management
のスコープを使用してLWAトークンを設定する必要があります。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、カナダ、ドイツ、スペイン、フランス、イタリア、英国、日本 |
米国、カナダ、ドイツ、スペイン、フランス、イタリア、英国、日本 |
米国 |
リクエスト
Wi-Fi設定を保存するには、credentiallocker/v2/saveWifiConfigurations
リソースに対してPOST
リクエストを実行します。この操作では、このガイドのほかの操作とは別のAPIエンドポイントが使用されます。
APIエンドポイント
組織が所在する国に応じて、リクエストヘッダーのHost
パラメーターを、以下のいずれかのAPIエンドポイントに設定してください。
国 | エンドポイント |
---|---|
カナダ、米国 |
|
ドイツ、スペイン、フランス、イタリア、英国 |
|
日本 |
|
リクエストパスとリクエストヘッダーの例
POST /credentiallocker/v2/saveWifiConfigurations
Host: credential-locker-service.amazon.com
x-amz-access-token: {access token}
Content-Type: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
以下は、ネットワークアクセスにWi-Fi Protected Access Pre-Shared Key(WPAPSK)を使用するWi-Fi設定の例です。
以下は、ネットワークアクセスにWi-Fi Protected Access 2(WPA2)拡張認証プロトコル(EAP)を使用するWi-Fi設定の例です。
リクエスト本文のプロパティ
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
|
Wi-Fi設定のリスト。 |
オブジェクトの配列 |
◯ |
|
Wi-Fiネットワークの認証情報。 |
オブジェクト |
◯ |
|
ネットワークアクセス用のWi-Fiパスワード。二重引用符で囲みます。 |
文字列 |
◯ |
|
ネットワークアクセスに拡張認証プロトコル(EAP)を使用する設定を識別します。 |
文字列 |
◯ |
|
認証局を識別します。 |
CertificateAuthorityオブジェクト |
◯ |
|
Wi-Fi設定のセキュリティタイプ。
|
文字列 |
◯ |
|
Wi-Fi設定の優先順位。 |
整数 |
✕ |
応答
正常に完了すると、HTTP 200 OK
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
Wi-Fi設定が正常に保存されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
Wi-Fi設定を設定する
保存されているWi-Fi設定を指定されたエンドポイントに関連付けます。エンドポイントごとに、最大32個のWi-Fi設定を関連付けることができます。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
なし |
米国、カナダ、英国、ドイツ、フランス、イタリア、スペイン、日本 |
米国、カナダ、英国、ドイツ、フランス、イタリア、スペイン、日本 |
なし |
リクエスト
Wi-Fi設定を設定するには、features/connectivity/addOrUpdateWifiConfigurations
リソースに対してPOST
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
POST /v2/endpoints/endpointId/features/connectivity/addOrUpdateWifiConfigurations
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
{
"payload": {
"wifiConfigurations": [{
"ssid": "\"wifi-ssid\"",
"keyManagement": "WPAPSK",
"priority": 1
}]
}
}
リクエスト本文のプロパティ
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
|
指定されたエンドポイントで追加または更新するWi-Fi設定のリスト。 |
オブジェクトの配列 |
◯ |
|
Wi-Fi設定のネットワーク名。二重引用符で囲みます。 |
文字列 |
◯ |
|
Wi-Fi設定のセキュリティタイプ。
|
文字列 |
◯ |
|
Wi-Fi設定の優先順位。 |
整数 |
✕ |
応答
正常に完了すると、HTTP 200 OK
と共に、インストールステータスを取得するための識別子が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
{
"submittedOperationId": "operationId"
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
インストールステータスの取得に使用できる操作ステータスID。 |
文字列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
デバイスとのペアリングが正常に解除されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
Bluetoothデバイスとのペアリングを解除する
指定したAlexa搭載エンドポイントからすべてのBluetoothデバイスとのペアリングを解除します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、カナダ、ドイツ、スペイン、フランス、イタリア、英国、日本 |
米国、カナダ、ドイツ、スペイン、フランス、イタリア、英国、日本 |
米国 |
リクエスト
Bluetoothデバイスとのペアリングを解除するには、features/bluetooth/
リソースに対してPOST
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
POST /v2/endpoints/{endpointId}/features/bluetooth/unpair
Host: api.amazonalexa.com
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 202 Accepted
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
デバイスとのペアリングが正常に解除されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
輝度を更新する
指定されたエンドポイントの輝度レベルを設定します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、日本 |
米国 |
リクエスト
輝度を設定するには、features/brightness
リソースに対してPOST
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
POST /v2/endpoints/{endpointId}/features/brightness/{operation}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
パス |
輝度レベルを調整または設定するための操作。有効な値は |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
以下は、adjustBrightness
操作のリクエスト本文の例です。
{
"payload": {
"brightnessDelta": -25
}
}
以下は、setBrightness
操作のリクエスト本文の例です。
{
"payload": {
"brightness": 75
}
}
リクエスト本文のプロパティ
プロパティ | 説明 | 型 | 必須 |
---|---|---|---|
|
|
オブジェクト |
◯ |
|
エンドポイントの輝度の設定値(%)。 |
整数 |
✕ |
|
エンドポイントの輝度の変更量(%)。 |
整数 |
✕ |
応答
正常に完了すると、HTTP 200 OK
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントでプロパティが正常に更新されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
色を更新する
指定されたエンドポイントの色を設定します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、日本 |
米国 |
リクエスト
色を設定するには、features/color
リソースに対してPOST
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
POST /v2/endpoints/{endpointId}/features/color/setColor`
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
{
"payload": {
"color": {
"hue": 20,
"saturation": 0.75,
"brightness": 0.34
}
}
}
リクエスト本文のプロパティ
プロパティ | 説明 | 型 | 必須 |
---|---|---|---|
|
|
オブジェクト |
◯ |
|
エンドポイントの設定色を定義します。 |
整数 |
◯ |
|
色の現在の色相値。 |
整数 |
◯ |
|
色の現在の彩度レベル。 |
浮動小数点 |
◯ |
|
現在の輝度。 |
浮動小数点 |
◯ |
応答
正常に完了すると、HTTP 200 OK
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントでプロパティが正常に更新されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
色温度を更新する
指定されたエンドポイントの色温度を設定します。色温度は特定の値に設定できます。または、色温度を上げて現在の設定よりも寒色または白色にしたり、色温度を下げて現在の設定よりも暖色または柔らかい色にしたりすることもできます。設定をどの程度増減するかの選択はエンドポイントの製造元が行います。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、日本 |
米国 |
リクエスト
色温度を設定するには、features/colorTemperature
リソースに対してPOST
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
POST /v2/endpoints/{endpointId}/features/colorTemperature/{operation}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
パス |
輝度レベルを調整または設定するための輝度操作。有効な値は |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
decreaseColorTemperature
およびincreaseColorTemperature
操作には、リクエスト本文はありません。
以下は、setColorTemperature
操作のリクエスト本文の例です。
{
"payload": {
"colorTemperatureInKelvin": 2000
}
}
リクエスト本文のプロパティ
プロパティ | 説明 | 型 | 必須 |
---|---|---|---|
|
|
オブジェクト |
✕ |
|
エンドポイントの色温度(ケルビン単位)。白の色調の詳細については、色温度の値を参照してください。 |
整数 |
✕ |
応答
正常に完了すると、HTTP 200 OK
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントでプロパティが正常に更新されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
電源状態を更新する
指定されたエンドポイントの電源のオン/オフを切り替えます。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、日本 |
米国 |
リクエスト
電源状態を設定するには、features/power
リソースに対してPOST
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
POST /v2/endpoints/{endpointId}/features/power/{operation}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
パス |
電源のオン/オフを切り替えるための操作。有効な値は |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントでプロパティが正常に更新されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
スピーカーのプロパティを更新する
指定されたエンドポイントのスピーカーの音量を設定または調整します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
スピーカーのプロパティを設定するには、features/speaker
リソースに対してPOST
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
POST /v2/endpoints/{endpointId}/features/speaker/{operation}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 位置 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。 |
文字列 |
◯ |
|
パス |
スピーカーの音量を設定または調整するための操作。有効な値は |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
以下は、adjustVolume
操作のリクエスト本文の例です。
{
"payload": {
"volumeDelta": -25
}
}
以下は、setVolume
操作のリクエスト本文の例です。
{
"payload": {
"volume": 75
}
}
リクエスト本文のプロパティ
プロパティ | 説明 | 型 | 必須 |
---|---|---|---|
|
|
オブジェクト |
◯ |
|
エンドポイントの音量の設定値。 |
整数 |
✕ |
|
エンドポイントの音量の変更量。 |
整数 |
✕ |
応答
正常に完了すると、HTTP 200 OK
が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンドポイントでプロパティが正常に更新されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
オブジェクトの定義
エンドポイント機能APIでは、以下のオブジェクト定義とプロパティ値が定義されています。
CertificateAuthorityオブジェクト
CertificateAuthority
オブジェクトは、デジタル証明書の作成および検証を行う認証局組織を識別します。
プロパティ | 説明 | 型 |
---|---|---|
|
認証局組織を識別します。 |
文字列 |
◯ |
|
プロバイダーシステム内の認証局リソースのID。 |
文字列 |
◯ |
色温度の値
次の表に、白の色調と対応する色温度の値の例を示します。
色調 | 絶対色温度(ケルビン単位) |
---|---|
暖色 |
2200 |
電球色 |
2700 |
白っぽい色 |
4000 |
昼白色 |
5500 |
クールホワイト |
7000 |
Operationオブジェクト
Operation
オブジェクトは、指定されたエンドポイントや機能で使用可能な更新操作を表します。
プロパティ | 説明 | 型 |
---|---|---|
|
更新操作の名前。 |
文字列 |
|
更新操作で |
文字列 |
Temperatureオブジェクト
Temperature
オブジェクトは、エンドポイントで検出された現在の温度を表します。
プロパティ | 説明 | 型 |
---|---|---|
|
温度(度単位)。 |
浮動小数点 |
|
温度の単位。 |
文字列 |
ThermostatModeの値
次の表に、サーモスタットのモード値の文字列を示します。サーモスタットによっては、すべてのモードがサポートされていない場合があります。
値 | 説明 |
---|---|
|
現在の温度と設定値に基づく自動暖房/冷房モード。 |
|
冷房モード。 |
|
エコノミーモード。 |
|
緊急暖房モード。 |
|
暖房モード。 |
|
暖房・冷房はオフですが、デバイスの電源が入っている可能性があります。 |
Errorオブジェクト
Error
オブジェクトは、発生したエラーを表します。
プロパティ | 説明 | 型 |
---|---|---|
|
発生したエラーのタイプ。 |
文字列 |
|
読み取り可能なエラーメッセージ。 |
文字列 |
関連トピック
最終更新日: 2024 年 06 月 21 日