---
metadata:
- name: generator
content: Diplodoc Platform v5.66.0
alternate:
- https://yandex.ru/dev/dialogs/smart-home/doc/en/concepts/platform-device-info.md
- https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/platform-device-info.md
- href: https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/platform-device-info.md
type: text/markdown
title: Markdown version
- href: https://yandex.ru/dev/dialogs/smart-home/doc/ru/llms.txt?revision=r21995741
rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/dialogs/smart-home/doc/ru/llms.txt?revision=r21995741
# Получение информации о состоянии устройства
Запрос информации об актуальном состоянии устройства пользователя.
## Формат запроса {#format-request}
```bash translate=no
GET https://api.iot.yandex.net/v1.0/devices/{[device_id](*device_id)}
```
#|
||
device_id
|
Идентификатор устройства пользователя.
||
|#
#### Заголовки запроса {#headers}
#|
||
**Заголовок**
|
**Описание**
|
**Обязательный**
||
||
Authorization
|
Авторизационный токен oauth-приложения.
|
Да
||
|#
## Формат ответа {#format-response}
{% list tabs %}
- Успешный ответ
```json translate=no
HTTP/1.1 200 OK
{
"status": "ok",
"request_id": String,
"id": String,
"name": String,
"aliases": [String],
"type": "devices.types.{type}",
"state": String,
"groups": [String],
"room": String,
"external_id": String,
"skill_id": String,
"capabilities": [{
"retrievable": Boolean,
"[type](*row-capability-type)": "devices.capabilities.{capability}",
"parameters": {},
"[state](*row-capability-state)": {},
"last_updated": Float
},
{
"retrievable": Boolean,
"[type](*row-capability-type)": "devices.capabilities.{capability}",
"parameters": {},
"[state](*row-capability-state)": {},
"last_updated": Float
}
],
"properties": [{
"retrievable": Boolean,
"type": "devices.properties.{property}",
"parameters": {},
"state": {},
"last_updated": Float
},
{
"retrievable": Boolean,
"type": "devices.properties.{property}",
"parameters": {},
"state": {},
"last_updated": Float
}
]
}
```
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
status
|
[String](*string)
|
Статус обработки запроса. Допустимые значения:
- `ok`.
|
Да
||
||
request_id
|
[String](*string)
|
Идентификатор запроса. Необходимо логировать для расследования инцидентов.
|
Да
||
||
id
|
[String](*string)
|
Идентификатор устройства.
|
Да
||
||
name
|
[String](*string)
|
Имя устройства.
|
Да
||
||
aliases
|
[Array](*array) of [Strings](*string)
|
Массив с дополнительными именами устройства.
|
Да
||
||
room
|
[String](*string)
|
Идентификатор комнаты устройства. Значение `null` передается, если устройство не привязано к комнате.
|
Да
||
||
external_id
|
[String](*string)
|
Идентификатор устройства в облаке производителя.
|
Да
||
||
skill_id
|
[String](*string)
|
Идентификатор навыка производителя устройства
|
Да
||
||
type
|
[String](*string)
|
[Тип устройства](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/device-types.md#types).
|
Да
||
||
state
|
[String](*string)
|
Состояние устройства. Допустимые значения:
- `online`;
- `offline`.
|
Да
||
||
groups
|
[Array](*array) of [Strings](*string)
|
Массив с идентификаторами групп устройства.
|
Да
||
||
capabilities
|
[Array](*array) of [CapabilityObjects](#capability_object)
|
Массив с информацией об умениях устройства.
|
Да
||
||
properties
|
[Array](*array) of [PropertyObjects](#property_object)
|
Массив с информацией о свойствах устройства.
|
Да
||
|#
**Массив `capabilities`**
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
capability1
|
[CapabilityObject](#capability_object)
|
Описание умения.
|
Нет
||
||
capability2
|
[CapabilityObject](#capability_object)
|
Описание умения.
|
Нет
||
|#
**Массив `properties`**
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
property1
|
[PropertyObject](#property_object)
|
Описание свойства.
|
Нет
||
||
property2
|
[PropertyObject](#property_object)
|
Описание свойства.
|
Нет
||
|#
##### **Тип `CapabilityObject`** {#capability_object}
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
type
|
[String](*string)
|
[Тип умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/capability-types.md#types).
|
Да
||
||
retrievable
|
[Boolean](*boolean)
|
Доступен ли для данного умения устройства запрос состояния.
|
Да
||
||
parameters
|
CapabilityParametersObject
|
Параметры умения. Соответствует значению поля `parameters` из [описания умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/on_off.md#discovery-example).
|
Да
||
||
state
|
CapabilityStateObject
|
Текущее состояние умения. Если значение `null`, значит состояние никогда не передавалось в систему. Соответствует значению поля `state` из [описания умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/on_off.md#state-example).
|
Да
||
||
last_updated
|
[Float](*float)
|
Время последнего обновления состояния в секундах, формат unix timestamp.
|
Да
||
|#
##### **Тип `PropertyObject`** {#property_object}
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
type
|
[String](*string)
|
[Тип свойства](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/properties-types.md#types).
|
Да
||
||
retrievable
|
[Boolean](*boolean)
|
Доступен ли для данного свойства устройства запрос состояния.
|
Да
||
||
parameters
|
PropertyParametersObject
|
Параметры свойства. Соответствует значению поля `parameters` из [описания свойства](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/float.md#example).
|
Да
||
||
state
|
PropertyStateObject
|
Текущее состояние свойства. Если значение `null`, значит состояние никогда не передавалось в систему. Соответствует значению поля `state` из [описания свойства](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/float.md#example).
|
Да
||
||
last_updated
|
[Float](*float)
|
Время последнего обновления состояния в секундах, формат unix timestamp.
|
Да
||
|#
- Ответ с ошибкой
```json translate=no
HTTP/1.1 404 Not Found
{
"[request_id](*row-err-request_id)": String,
"[status](*row-err-status)": "error",
"[message](*row-err-message)": String
}
```
#|
||
**Параметр**
|
**Тип**
|
**Описание**
|
**Обязательный**
||
||
request_id
|
[String](*string)
|
Идентификатор запроса. Необходимо логировать для расследования инцидентов.
|
Да
||
||
status
|
[String](*string)
|
Статус обработки запроса. Допустимые значения:
- `error`.
|
Да
||
||
message
|
[String](*string)
|
Сообщение об ошибке.
|
Нет
||
|#
[Коды ошибок](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/platform-error-codes.md)
{% endlist %}
## Пример {#example}
{% list tabs %}
- Запрос
```bash translate=no
curl -i -X GET 'https://api.iot.yandex.net/v1.0/devices/lamp-id-1' \
-H 'Authorization: Bearer 123qwe456a...'
```
- Успешный ответ
```json translate=no
HTTP/1.1 200 OK
{
"status": "ok",
"request_id": "fd9299b8-f927-44f1-8728-8a0b35f1c72a",
"id": "lamp-id-1",
"name": "Лампочка 1",
"aliases": [],
"type": "devices.types.light",
"state": "online",
"groups": [
"light-group-id-1"
],
"room": "room-id-1",
"external_id": "external-lamp-id-1",
"skill_id": "skill-id-1",
"capabilities": [{
"retrievable": true,
"type": "devices.capabilities.on_off",
"parameters": {
"split": false
},
"state": {
"instance": "on",
"value": false
},
"last_updated": 1626702522.614036
},
{
"retrievable": true,
"type": "devices.capabilities.range",
"parameters": {
"instance": "brightness",
"unit": "unit.percent",
"random_access": true,
"range": {
"min": 1,
"max": 100,
"precision": 1
}
},
"state": {
"instance": "brightness",
"value": 100
},
"last_updated": 1626702522.614036
},
{
"retrievable": true,
"type": "devices.capabilities.color_setting",
"parameters": {
"color_model": "rgb",
"temperature_k": {
"min": 1700,
"max": 6500
}
},
"state": {
"instance": "temperature_k",
"value": 3400
},
"last_updated": 1626702522.614036
}
],
"properties": []
}
```
- Ответ с ошибкой
```json translate=no
HTTP/1.1 404 Not Found
{
"request_id": "9813e54b-021d-4203-b22a-02c6370d07b1",
"status": "error",
"message": "Устройство не найдено"
}
```
{% endlist %}
[](https://yandex.ru/dev/dialogs/smart-home/doc/ru/feedback.md)
[*string]:
Cтрока, выделяется кавычками, например `"Hello world"`.
[*array]:
Массив элементов, разделенных запятой. Элементом могут быть стандартные элементы JSON: строка, число, `true`, `false`, объект или массив. Массив выделяется квадратными скобками `[]`:
```json translate=no
"cities": ["Moscow", "Tokyo", "New York"]
```
[*float]:
Число с плавающей точкой с точностью до 6-9 десятичных знаков.
[*boolean]:
Логическое значение без кавычек: `true` (истина) или `false` (ложь).
[*device_id]: Идентификатор устройства пользователя.
[*row-capability-type]:
**Тип**
[String](*string)
**Описание**
[Тип умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/capability-types.md#types).
**Обязательный**
Да
[*row-capability-state]:
**Тип**
CapabilityStateObject
**Описание**
Текущее состояние умения. Если значение `null`, значит состояние никогда не передавалось в систему. Соответствует значению поля `state` из [описания умения](https://yandex.ru/dev/dialogs/smart-home/doc/ru/concepts/on_off.md#example).
**Обязательный**
Да
[*row-err-request_id]:
**Тип**
[String](*string)
**Описание**
Сообщение об ошибке.
**Обязательный**
Нет
[*row-err-status]:
**Тип**
[String](*string)
**Описание**
Статус обработки запроса. Допустимые значения:
- `error`.
**Обязательный**
Да
[*row-err-message]:
**Тип**
[String](*string)
**Описание**
Сообщение об ошибке.
**Обязательный**
Нет