action.devices.QUERY

Este intent consulta tu entrega para los estados actuales de los dispositivos, incluso si el dispositivo está en línea y es accesible.

Tu respuesta QUERY solo debe mostrar información de estado. La respuesta SYNC controla la actualización de los atributos y las características del dispositivo.

Para obtener más detalles, consulta Cómo ejecutar y consultar.

Formato de la solicitud

Campos Tipo Descripción
requestId String

Obligatorio.

ID de la solicitud.

inputs Matriz

Obligatorio.

Lista de entradas que coinciden con la solicitud del intent.

[item, ...] Objeto

Tipo y carga útil asociadas con la solicitud de intent

intent

Obligatorio.

(Valor de la constante: "action.devices.QUERY")

Tipo de solicitud de intent.

payload Objeto

Obligatorio.

Carga útil de solicitud de QUERY

devices Matriz

Obligatorio.

Lista de dispositivos de destino.

[item, ...] Objeto

Orientaciones del dispositivo que se consultarán.

id String

Obligatorio.

ID del dispositivo, según el ID proporcionado en SYNC.

customData Objeto

Si el objeto customData opaco se proporciona en SYNC, se envía aquí.

Ejemplos

Solicitud de 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 de la respuesta

Campos Tipo Descripción
requestId String

Obligatorio.

ID de la solicitud correspondiente.

payload Objeto

Obligatorio.

Carga útil de respuesta de intent.

errorCode String

Un código de error de toda la transacción para fallas de autenticación y falta de disponibilidad del sistema para desarrolladores Para errores de dispositivos individuales, usa el errorCode dentro del objeto del dispositivo.

debugString String

Es un error detallado que nunca se presentará a los usuarios, pero que se podrá registrar o usar durante el desarrollo.

devices Objeto

Obligatorio.

Mapa de dispositivos Asigna el ID de dispositivo del desarrollador al objeto de las propiedades de estado.

<string> Objeto

Estado del dispositivo.

online Booleano

Obligatorio.

Indica si el dispositivo está en línea (es decir, si se puede acceder a él) o no.

status String

Obligatorio.

Resultado de la operación de consulta.

Valores admitidos:

SUCCESS
Confirma que la consulta se realizó correctamente.
OFFLINE
El dispositivo de destino está en estado sin conexión o inaccesible.
EXCEPTIONS
Hay un problema o una alerta asociada a una consulta. La consulta podría tener éxito o fallar. Por lo general, este tipo de estado se establece cuando quieres enviar información adicional sobre otro dispositivo conectado.
ERROR
No se puede consultar el dispositivo de destino.
errorCode String

Expande el estado ERROR si es necesario a partir de los códigos de error predeterminados, que se asignarán a los errores que se presentan a los usuarios.

Ejemplos

Respuesta del intent de 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
        }
      }
    }
  }
}