action.devices.QUERY
このインテントは、フルフィルメントが照会された現在のデバイスの状態(デバイスがオンラインかどうか、到達可能かなど)を確認します。
QUERY
レスポンスでは、状態情報のみが返されます。デバイスの属性とトレイトの更新は、SYNC
レスポンスによって処理されます。
詳細については、クエリと実行をご覧ください。
リクエストの形式
フィールド | タイプ | 説明 |
---|---|---|
requestId |
文字列 |
必須。 リクエストの ID。 |
inputs |
配列 |
必須。 インテント リクエストと一致する入力のリスト。 |
[item, ...] |
オブジェクト |
インテント リクエストに関連付けられているタイプとペイロード。 |
intent |
必須。 (定数値: インテント リクエストのタイプ。 |
|
payload |
オブジェクト |
必須。 QUERY リクエストのペイロード。 |
devices |
配列 |
必須。 対象デバイスのリスト。 |
[item, ...] |
オブジェクト |
クエリを実行するデバイス ターゲット。 |
id |
文字列 |
必須。 SYNC で指定された ID でのデバイス ID。 |
customData |
オブジェクト |
不透明な customData オブジェクトが SYNC で指定されている場合は、ここで送信されます。 |
例
QUERY インテント リクエスト
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "inputs": [ { "intent": "action.devices.QUERY", "payload": { "devices": [ { "id": "123", "customData": { "fooValue": 74, "barValue": true, "bazValue": "foo" } }, { "id": "456", "customData": { "fooValue": 12, "barValue": false, "bazValue": "bar" } } ] } } ] }
レスポンスの形式
フィールド | タイプ | 説明 |
---|---|---|
requestId |
文字列 |
必須。 対応するリクエストの ID。 |
payload |
オブジェクト |
必須。 インテント レスポンスのペイロード。 |
errorCode |
文字列 |
認証エラーやデベロッパー システムが利用できないトランザクション全体のエラーコード。個々のデバイスのエラーには、デバイス オブジェクト内の errorCode を使用します。 |
debugString |
文字列 |
エラーの詳細。ユーザーには表示されませんが、開発中にログに記録または使用される可能性があります。 |
devices |
オブジェクト |
必須。 デバイスのマップ。デベロッパーのデバイス ID を、状態プロパティのオブジェクトにマッピングします。 |
<string> |
オブジェクト |
デバイスの状態。 |
online |
ブール値 |
必須。 デバイスがオンライン(つまりアクセス可能)かどうかを示します。 |
status |
文字列 |
必須。 クエリ オペレーションの結果。 サポートされている値:
|
errorCode |
文字列 |
ERROR 状態を、必要に応じて、プリセットのエラーコードから拡張します。ユーザーに表示されるエラーに対応付けられます。 |
例
QUERY インテント レスポンス
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "devices": { "123": { "on": true, "online": true, "status": "SUCCESS" }, "456": { "on": true, "online": true, "status": "SUCCESS", "brightness": 80, "color": { "spectrumRgb": 16711935 } } } } }