Aktion.Geräte.QUERY
Dieser Intent fragt die Auftragsausführung nach dem aktuellen Gerätestatus ab, einschließlich der Frage, ob das Gerät online und erreichbar ist.
Ihre QUERY
-Antwort sollte nur Statusinformationen zurückgeben.
Das Aktualisieren der Attribute und Merkmale des Geräts wird von der SYNC
-Antwort verarbeitet.
Weitere Informationen finden Sie unter Abfragen und ausführen.
Anfrageformat
Felder | Typ | Beschreibung |
---|---|---|
requestId |
String |
Erforderlich. ID der Anfrage. |
inputs |
Array |
Erforderlich. Liste der Eingaben, die der Intent-Anfrage entsprechen. |
[item, ...] |
Objekt |
Typ und Nutzlast der Intent-Anfrage. |
intent |
Erforderlich. (Konstante Wert: Intent-Anfragetyp. |
|
payload |
Objekt |
Erforderlich. Nutzlast der QUERY-Anfrage. |
devices |
Array |
Erforderlich. Liste der Zielgeräte. |
[item, ...] |
Objekt |
Geräteziele, die abgefragt werden sollen. |
id |
String |
Erforderlich. Geräte-ID gemäß der in SYNC zur Verfügung gestellten ID |
customData |
Objekt |
Wenn das intransparente benutzerdefinierte DataData-Objekt in SYNC bereitgestellt wird, wird es hier gesendet. |
Beispiele
QUERY-Anfrage
{ "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" } } ] } } ] }
Antwortformat
Felder | Typ | Beschreibung |
---|---|---|
requestId |
String |
Erforderlich. ID der entsprechenden Anfrage. |
payload |
Objekt |
Erforderlich. Nutzlast der Intent-Antwort. |
errorCode |
String |
Ein Fehlercode für die gesamte Transaktion bei Authentifizierungsfehlern und Nichtverfügbarkeit des Entwicklersystems. Verwenden Sie für einzelne Gerätefehler den errorCode im Geräteobjekt. |
debugString |
String |
Detaillierter Fehler, der Nutzern nicht angezeigt, aber während der Entwicklung protokolliert oder verwendet werden kann. |
devices |
Objekt |
Erforderlich. Karte mit Geräten Ordnet die Entwickler-ID des Entwicklers dem Objekt der Statuseigenschaften zu. |
<string> |
Objekt |
Gerätestatus |
online |
Boolesch |
Erforderlich. Gibt an, ob das Gerät online ist, also erreichbar ist, oder nicht. |
status |
String |
Erforderlich. Ergebnis des Abfragevorgangs. Unterstützte Werte:
|
errorCode |
String |
Erweitern des Fehlerstatus bei Bedarf aus den voreingestellten Fehlercodes, die den Fehlern zugeordnet werden. |
Beispiele
Anfrage mit gemeinsamer Absicht
{ "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 } } } } }