action.devices.QUERY

Dieser Intent fragt Ihre Auftragsausführung nach dem aktuellen Status der Geräte ab, einschließlich der Frage, ob das Gerät online und erreichbar ist.

Die QUERY-Antwort sollte nur Statusinformationen zurückgeben. Das Aktualisieren der Attribute und Traits des Geräts erfolgt durch SYNC Antwort.

Weitere Informationen finden Sie unter Abfragen und Ausführungen.

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, die der Intent-Anfrage zugeordnet sind.
intent

Erforderlich.

(Konstanter Wert: "action.devices.QUERY")

Intent-Anfragetyp.
payload Objekt

Erforderlich.

QUERY-Anfragenutzlast
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 angegebenen ID.
customData Objekt

Wenn das intransparente „customData“-Objekt in SYNC angegeben wird, wird es hier gesendet.
Beispiele

QUERY-Intent-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

Fehlercode für die gesamte Transaktion für Authentifizierungsfehler und Nichtverfügbarkeit des Entwicklersystems. Verwenden Sie für einzelne Gerätefehler den Fehlercode im Geräteobjekt.
debugString String

Detaillierter Fehler, der Nutzern nie angezeigt wird, aber protokolliert oder während der Entwicklung verwendet werden kann.
devices Objekt

Erforderlich.

Karte mit Geräten. Ordnet die Entwicklergeräte-ID dem Objekt der Statuseigenschaften zu.
<string> Objekt

Gerätestatus.
online Boolesch

Erforderlich.

Gibt an, ob das Gerät online (d. h. erreichbar) ist oder nicht.
status String

Erforderlich.

Ergebnis des Abfragevorgangs.

Unterstützte Werte:

SUCCESS
Prüfen Sie, ob die Abfrage erfolgreich war.
OFFLINE
Das Zielgerät ist offline oder nicht erreichbar.
EXCEPTIONS
Mit einer Abfrage ist ein Problem oder eine Benachrichtigung verknüpft. Die Abfrage könnte erfolgreich oder fehlschlagen. Dieser Statustyp wird normalerweise festgelegt, wenn Sie zusätzliche Informationen über ein anderes verbundenes Gerät senden möchten.
ERROR
Fehler beim Abfragen des Zielgeräts.
errorCode String

Bei Bedarf wird der FEHLER-Status aus den voreingestellten Fehlercodes erweitert. Diese werden den Fehlern zugeordnet, die Nutzern angezeigt werden.
Beispiele

QUERY-Intent-Antwort

{
  "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
        }
      }
    }
  }
}