action.devices.QUERY

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

Tu respuesta de QUERY solo debe mostrar información de estado. La actualización de los atributos y rasgos del dispositivo se controla Respuesta SYNC.

Para obtener más detalles, lee Consulta y ejecuta.

Formato de la solicitud

Campos Tipo Descripción
requestId String

Obligatorio.

Es el ID de la solicitud.

inputs Matriz

Obligatorio.

Lista de entradas que coinciden con la solicitud de intent.

[item, ...] Objeto

Tipo y carga útil asociados con la solicitud de intent.

intent

Obligatorio.

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

Tipo de solicitud de intent.

payload Objeto

Obligatorio.

Carga útil de la solicitud de QUERY.

devices Matriz

Obligatorio.

Lista de dispositivos de destino.

[item, ...] Objeto

Destinos de dispositivo a consultar.

id String

Obligatorio.

ID de 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 respuesta

Campos Tipo Descripción
requestId String

Obligatorio.

Es el ID de la solicitud correspondiente.

payload Objeto

Obligatorio.

Carga útil de la respuesta de intent.

errorCode String

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

debugString String

Errores detallados que nunca se presentarán a los usuarios, pero que pueden registrarse o usarse durante el desarrollo.

devices Objeto

Obligatorio.

Mapa de dispositivos Asigna el ID de dispositivo del desarrollador de Maps 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, es accesible) o no.

status String

Obligatorio.

Resultado de la operación de consulta.

Valores admitidos:

SUCCESS
Confirma que la consulta se haya realizado correctamente.
OFFLINE
El dispositivo de destino se encuentra en estado sin conexión o es inaccesible.
EXCEPTIONS
Hay un problema o una alerta asociados con una consulta. La consulta podría completarse con é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 pudo consultar el dispositivo de destino.
errorCode String

Expansión del estado de 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 al 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
        }
      }
    }
  }
}