action.devices.QUERY

Essa intent consulta o fulfillment dos estados atuais dos dispositivos, incluindo se ele está on-line e acessível.

A resposta QUERY vai retornar apenas informações de estado. A atualização dos atributos e características do dispositivo é tratada pela resposta SYNC.

Veja mais detalhes em Consultar e executar.

Formato da solicitação

Campos Tipo Descrição
requestId String

Obrigatório.

ID da solicitação.

inputs Array

Obrigatório.

Lista de entradas que correspondem à solicitação de intent.

[item, ...] Object

Tipo e payload associados à solicitação de intent.

intent

Obrigatório.

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

Tipo de solicitação de intent.

payload Object

Obrigatório.

Payload de solicitação QUERY.

devices Array

Obrigatório.

Lista de dispositivos de destino.

[item, ...] Object

Destinos de dispositivo a serem consultados.

id String

Obrigatório.

ID do dispositivo, conforme o ID fornecido em SYNC.

customData Object

Se o objeto customData opaco for fornecido em SYNC, ele será enviado aqui.

Exemplos

Solicitação de intent de CONSULTA

{
  "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 da resposta

Campos Tipo Descrição
requestId String

Obrigatório.

É o ID da solicitação correspondente.

payload Object

Obrigatório.

Payload de resposta de intent.

errorCode String

Um código de erro para toda a transação com falhas de autenticação e indisponibilidade do sistema do desenvolvedor. Para erros individuais de dispositivos, use o errorCode no objeto do dispositivo.

debugString String

Erro detalhado que nunca será apresentado aos usuários, mas poderá ser registrado ou usado durante o desenvolvimento.

devices Object

Obrigatório.

Mapa de dispositivos. ID do dispositivo do desenvolvedor do Maps para o objeto das propriedades de estado.

<string> Object

Estado do dispositivo.

online Booleano

Obrigatório.

Indica se o dispositivo está on-line (ou seja, acessível) ou não.

status String

Obrigatório.

Resultado da operação de consulta.

Os valores suportados são:

SUCCESS
Confirme se a consulta foi concluída.
OFFLINE
O dispositivo de destino está off-line ou inacessível.
EXCEPTIONS
Há um problema ou alerta associado a uma consulta. A consulta pode ter êxito ou falhar. Esse tipo de status geralmente é definido quando você quer enviar informações adicionais sobre outro dispositivo conectado.
ERROR
Não foi possível consultar o dispositivo de destino.
errorCode String

Expandindo o estado ERROR, se necessário, dos códigos de erro predefinidos, que mapeiam os erros apresentados aos usuários.

Exemplos

Resposta à intent de consulta

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