действие.устройства.ЗАПРОС

Это намерение запрашивает у вас информацию о текущем состоянии устройств, в том числе о том, находится ли устройство в сети и доступно ли оно.

Ваш ответ QUERY должен возвращать только информацию о состоянии. Обновление атрибутов и характеристик устройства обрабатывается ответом SYNC .

Дополнительные сведения см. в разделе Запрос и выполнение .

Формат запроса

Поля Тип Описание
requestId Нить

Необходимый.

Идентификатор запроса.

inputs Множество

Необходимый.

Список входных данных, соответствующих запросу намерения.

[ item, ... ] Объект

Тип и полезные данные, связанные с запросом намерения.

intent

Необходимый.

(Постоянное значение: "action.devices.QUERY" )

Тип запроса намерения.

payload Объект

Необходимый.

Полезная нагрузка запроса QUERY.

devices Множество

Необходимый.

Список целевых устройств.

[ item, ... ] Объект

Целевые устройства для запроса.

id Нить

Необходимый.

Идентификатор устройства в соответствии с идентификатором, указанным в SYNC.

customData Объект

Если непрозрачный объект customData предоставляется в SYNC, он отправляется сюда.

Примеры

Запрос намерения 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"
            }
          }
        ]
      }
    }
  ]
}

Формат ответа

Поля Тип Описание
requestId Нить

Необходимый.

Идентификатор соответствующего запроса.

payload Объект

Необходимый.

Полезная нагрузка ответа на намерение.

errorCode Нить

Код ошибки для всей транзакции из-за сбоев аутентификации и недоступности системы разработчика. Для ошибок отдельных устройств используйте errorCode внутри объекта устройства.

debugString Нить

Подробная ошибка, которая никогда не будет представлена ​​пользователям, но может быть зарегистрирована или использована во время разработки.

devices Объект

Необходимый.

Карта устройств. Сопоставляет идентификатор устройства разработчика с объектом свойств состояния.

<string> Объект

Состояние устройства.

online логическое значение

Необходимый.

Указывает, находится ли устройство в сети (то есть доступно) или нет.

status Нить

Необходимый.

Результат операции запроса.

Поддерживаемые значения:

SUCCESS
Подтвердите, что запрос выполнен успешно.
OFFLINE
Целевое устройство находится в автономном режиме или недоступно.
EXCEPTIONS
С запросом связана проблема или предупреждение. Запрос может быть успешным или неудачным. Этот тип статуса обычно устанавливается, когда вы хотите отправить дополнительную информацию о другом подключенном устройстве.
ERROR
Невозможно запросить целевое устройство.
errorCode Нить

При необходимости расширение состояния ОШИБКА из предустановленных кодов ошибок, которые будут сопоставлены с ошибками, представленными пользователям.

Примеры

Ответ на запрос запроса

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