action.devices.QUERY

Questo intent esegue la query sul tuo evasione per gli stati correnti dei dispositivi, incluso se il dispositivo è online e raggiungibile.

La tua risposta QUERY dovrebbe restituire solo informazioni sullo stato. L'aggiornamento degli attributi e delle caratteristiche del dispositivo viene gestito dalla risposta SYNC.

Per maggiori dettagli, vedi Eseguire ed eseguire query.

Formato della richiesta

Campi Tipo Descrizione
requestId Stringa

Obbligatorio.

ID della richiesta.
inputs Array

Obbligatorio.

Elenco di input corrispondenti alla richiesta di intent.
[item, ...] Oggetto

Tipo e payload associati alla richiesta di intent.
intent

Obbligatorio.

(Valore costante: "action.devices.QUERY")

Tipo di richiesta di intent.
payload Oggetto

Obbligatorio.

Payload della richiesta QUERY.
devices Array

Obbligatorio.

Elenco dei dispositivi di destinazione.
[item, ...] Oggetto

Dispositivo target a cui eseguire la query.
id Stringa

Obbligatorio.

ID dispositivo, in base all'ID fornito in SYNC.
customData Oggetto

Se l'oggetto customData opaco viene fornito in SYNC, viene inviato qui.
Esempi

Richiesta intent 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"
            }
          }
        ]
      }
    }
  ]
}

Formato della risposta

Campi Tipo Descrizione
requestId Stringa

Obbligatorio.

ID della richiesta corrispondente.
payload Oggetto

Obbligatorio.

Payload della risposta dell'intent.
errorCode Stringa

Un codice di errore per l'intera transazione per errori di autenticazione e disponibilità del sistema dello sviluppatore. Per gli errori relativi a singoli dispositivi, utilizza il codice di errore all'interno dell'oggetto del dispositivo.
debugString Stringa

Errore dettagliato che non verrà mai presentato agli utenti, ma potrebbe essere registrato o utilizzato durante lo sviluppo.
devices Oggetto

Obbligatorio.

Mappa dei dispositivi. Mappa l'ID dispositivo dello sviluppatore all'oggetto delle proprietà dello stato.
<string> Oggetto

Stato del dispositivo.
online Booleano

Obbligatorio.

Indica se il dispositivo è online (ossia raggiungibile).
status Stringa

Obbligatorio.

Risultato dell'operazione di query.

Valori supportati:

SUCCESS
Conferma che la query sia riuscita.
OFFLINE
Il dispositivo di destinazione è offline o non è raggiungibile.
EXCEPTIONS
È presente un problema o un avviso associato a una query. La query potrebbe avere esito positivo o negativo. In genere questo tipo di stato viene impostato quando vuoi inviare informazioni aggiuntive su un altro dispositivo connesso.
ERROR
Impossibile eseguire una query sul dispositivo di destinazione.
errorCode Stringa

Possibilità di espandere lo stato ERROR se necessario dai codici di errore preimpostati, che verranno mappati agli errori presentati agli utenti.
Esempi

Risposta all'intent 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
        }
      }
    }
  }
}