action.devices.QUERY

Questo intent esegue una query sull'evasione degli ordini per conoscere gli stati attuali dei dispositivi, inclusa l'eventuale presenza online e raggiungibile.

La risposta QUERY dovrebbe restituire solo informazioni sullo stato. L'aggiornamento degli attributi e dei tratti del dispositivo è gestito dall' Risposta SYNC.

Per maggiori dettagli, consulta Eseguire query ed eseguire.

Formato della richiesta

Campi Tipo Descrizione
requestId String

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

Target per dispositivo su cui eseguire query.
id String

Obbligatorio.

ID dispositivo, come per l'ID fornito in SYNC.
customData Oggetto

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

Richiesta di intent di 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 String

Obbligatorio.

ID della richiesta corrispondente.
payload Oggetto

Obbligatorio.

Payload della risposta dell'intent.
errorCode String

Un codice di errore per l'intera transazione per errori di autenticazione e mancata disponibilità del sistema degli sviluppatori. Per i singoli errori del dispositivo, utilizza il codice errorCode all'interno dell'oggetto dispositivo.
debugString String

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

Obbligatorio.

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

Stato del dispositivo.
online Valore booleano

Obbligatorio.

Indica se il dispositivo è online (ossia raggiungibile) o meno.
status String

Obbligatorio.

Risultato dell'operazione di query.

Valori supportati:

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

Espansione dello stato ERRORE, se necessario, dai codici di errore preimpostati, che verranno mappati agli errori presentati agli utenti.
Esempi

Risposta per intent di 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
        }
      }
    }
  }
}