Nest API работает со всеми моделями Nest Cam™.
Пользователи могут добавлять несколько камер Nest Cams в группу devices/cameras
, но не более чем на структуру . Когда вы звоните в это хранилище данных, вы можете получить доступ к данным Nest Cam (значениям данных для устройств в структуре).
Все приведенные ниже значения находятся под каждым devices/cameras/ device_id
в документе JSON.
идентификатор устройства
Уникальный идентификатор Nest Cam.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /device_id | |
Возвращает | string Пример: "awJo6rH..." |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
версия программного обеспечения
Версия программного обеспечения.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /software_version | |
Возвращает | string Пример: "4.0" |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
идентификатор_структуры
Уникальный идентификатор структуры.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /structure_id | |
Возвращает | string Пример: "VqFabWH21nw..." |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
где_ид
Уникальный идентификатор, сгенерированный Nest, который представляет name
отображаемое имя устройства.
Узнайте больше о названиях термостатов Nest, Nest Protects и Nest Cams .
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /where_id | |
Возвращает | string Пример: "d6reb_OZTM..." |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
где_имя
Отображаемое имя устройства. Связан с Nest Cam where_id
. Может быть любое имя комнаты из списка, который мы предоставляем, или пользовательское имя. Узнайте больше о названиях термостатов Nest, Nest Protects и Nest Cams .
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /where_name | |
Возвращает | string Пример: «Прихожая» |
Доступ | только для чтения |
Доступно в | Чтение камеры / v3 Чтение камеры + изображения / v4 Камера чтение/запись/v3 Камера чтение/запись + изображения/v4 |
название
Отображаемое имя устройства; может быть любое имя комнаты из списка, который мы предоставляем, или пользовательское имя.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /name | |
Возвращает | string Пример: «Прихожая» |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
имя_длинное
Длинное отображаемое имя устройства. Включает пользовательскую (метку), созданную пользователем или через wheres
.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /name_long | |
Возвращает | string Пример: «Камера гнезда в коридоре (наверху)» |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
В сети
Статус подключения устройства к сервису Nest.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_online | |
Возвращает | boolean Значения: правда, ложь |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
is_streaming
Статус камеры: включена и активно транслирует видео или выключена. Дополнительную информацию см. в разделе Как ваша камера работает с функцией Home/Away Assist .
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_streaming | |
Возвращает | boolean Значения: правда, ложь |
Доступ | читай пиши |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
is_audio_input_enabled
Статус микрофона камеры: включен и слушает или выключен. Узнайте больше о настройках звука Nest Cam .
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_audio_input_enabled | |
Возвращает | boolean Значения: правда, ложь |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
last_is_online_change
Временная метка, определяющая последнее изменение онлайн-статуса в формате ISO 8601 .
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_is_online_change | |
Возвращает | string Пример: "2016-12-29T18:42:00.000Z" |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
is_video_history_enabled
Статус подписки Nest Aware (подписка активна или нет).
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_video_history_enabled | |
Возвращает | boolean Значения: правда, ложь |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
web_url
Веб-URL (глубокая ссылка) на прямую видеотрансляцию на сайте home.nest.com .
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /web_url | |
Возвращает | string Пример: " https://home.nest.com/cameras/ device_id ?auth= camera_token " |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
app_url
URL-адрес приложения (глубокая ссылка) на прямой видеопоток в приложении Nest.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /app_url | |
Возвращает | string Пример: « nestmobile://cameras/ device_id ?auth= camera_token » |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
is_public_share_enabled
Пользователи могут поделиться своим видео и сделать его доступным для просмотра всем. Когда общедоступный ресурс включен, вы можете прочитать public_share_url
.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_public_share_enabled | |
Возвращает | boolean Значения: правда, ложь |
Доступ | только для чтения |
Доступно в | Чтение камеры + изображения / v3-v4 Камера чтение/запись + изображения / v3-v4 |
зоны активности
Возвращает массив всех определенных зон активности.
Зоны активности используются для отслеживания событий движения в определенных пользователем областях видеопотока. Требуется Nest Aware .
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /activity_zones | |
Возвращает | array Пример: [ {"name" : " string1 ", "id" : " string2 "},... ] • string1 — это имя зоны, определенное пользователем или сгенерированное автоматически при создании зоны.• string2 — это идентификатор, назначаемый Nest при создании Зоны активности. |
Доступ | только для чтения |
Доступно в | Чтение камеры + изображения / v3-v4 Камера чтение/запись + изображения / v3-v4 |
public_share_url
Вы можете получить доступ к этому URL-адресу, когда пользователь сделает свой видеопоток общедоступным .
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /public_share_url | |
Возвращает | string Пример: " https://video.nest.com/live/ string1 ? string2 "string1 — это имя видеопотока, определяемое пользователем или автоматически сгенерированное, когда поток становится общедоступным. |
Доступ | только для чтения |
Доступно в | Чтение камеры + изображения / v3-v4 Камера чтение/запись + изображения / v3-v4 |
snapshot_url
Захват изображения по запросу. Возвращает URL-адрес изображения, захваченного из видеопотока в реальном времени. Требуется, чтобы камера была включена и активно транслировалась.
Используйте это поле для получения снимка видеопотока в реальном времени.
-
snapshot_url
— возвращает URL-адрес изображения, захваченного из живого видеопотока. - Требуется, чтобы камера была включена и активно транслировала
Качество моментального снимка из API составляет только пропускную способность 1080p, если вы:
- активный просмотр потока камеры в приложении (
web_url
) - активно просматривая публичный поток (
app_url
) - подписался на Nest Aware
Если вы не просматриваете трансляцию активно или у вас нет подписки Nest Aware, у API нет источника 1080p, из которого можно получить снимок с таким разрешением, и создается изображение более низкого качества. Кроме того, низкая пропускная способность локальной сети может привести к тому, что разрешение снимков API упадет ниже 1080p при наличии Nest Aware.
Узнайте больше о требованиях к пропускной способности для камер Nest .
К этому звонку применяются ограничения скорости в зависимости от статуса подписки Nest Aware.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /snapshot_url | |
Возвращает | string Пример: " string1 / device_id / string2 ?auth= camera_token " |
Доступ | только для чтения |
Доступно в | Чтение камеры + изображения / v3-v4 Камера чтение/запись + изображения / v3-v4 |
last_event
Этот объект фиксирует информацию о последнем событии, вызвавшем уведомление.
Некоторые поля и некоторые комбинации разрешений требуют подписки Nest Aware для доступа к информации о последнем событии.
Все приведенные ниже значения находятся под каждым devices/cameras/ device_id /last_event
в документе JSON.
has_sound
Звуковое событие - обнаружен звук.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_sound | |
Возвращает | boolean Значения: правда, ложь |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
has_motion
Событие движения - обнаружено движение.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_motion | |
Возвращает | boolean Значения: правда, ложь |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
has_person
Событие человека - обнаружен человек.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_person | |
Возвращает | boolean Значения: правда, ложь |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
время начала
Время начала события в формате ISO 8601 .
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/start_time | |
Возвращает | string Пример: "2016-12-29T00:00:00.000Z" |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
время окончания
Время окончания события в формате ISO 8601 .
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/end_time | |
Возвращает | string Пример: "2016-12-29T00:00:00.000Z" |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
urls_expire_time
Отметка времени в формате ISO 8601 , указывающая на истечение срока действия этих URL-адресов, связанных с событиями:
Срок действия рассчитывается как: last_event/start_time
+ n дней (где n = 10 или 30 дней, в зависимости от плана подписки Nest Aware).
Требуется Nest Aware .
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/urls_expire_time | |
Возвращает | string Пример: "2016-12-29T00:00:00.000Z" |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
web_url
Веб-URL (глубокая ссылка) на последнее событие со звуком или движением на сайте home.nest.com . Используется для отображения последнего записанного события и требует, чтобы пользователь вошел в учетную запись.
Требуется Nest Aware . Если срок действия URL-адреса события истек или на устройстве нет активной подписки, это значение не включается в полезные данные.
См. last_event/urls_expire_time
для получения информации о сроке действия этого URL.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/web_url | |
Возвращает | string Пример: " https://home.nest.com/cameras/ device_id /cuepoints/ string ?auth= camera_token " |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
app_url
URL-адрес приложения Nest (глубокая ссылка) на последнее событие звука или движения. Используется для отображения последнего записанного события и требует, чтобы пользователь вошел в учетную запись.
Требуется Nest Aware . Если срок действия URL-адреса события истек или на устройстве нет активной подписки, это значение не включается в полезные данные.
См. last_event/urls_expire_time
для получения информации о сроке действия этого URL.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/app_url | |
Возвращает | string Пример: " nestmobile://cameras/ device_id /cuepoints/ string ?auth= camera_token " |
Доступ | только для чтения |
Доступно в | Чтение камеры / v1-v3 Чтение камеры + изображения / v1-v4 Камера чтение/запись / v1-v3 Камера чтение/запись + изображения / v1-v4 |
URL изображения
URL-адрес (ссылка) на файл изображения, захваченный для звука или движения.
Требуется Nest Aware . См. last_event/urls_expire_time
для получения информации о сроке действия этого URL.
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/image_url | |
Возвращает | string Пример: " https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token " |
Доступ | только для чтения |
Доступно в | Чтение камеры + изображения / v1-v4 Камера чтение/запись + изображения / v1-v4 |
анимированный_изображение_url
URL-адрес (ссылка) на файл gif, захваченный для звука или движения.
Требуется Nest Aware .
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/animated_image_url | |
Возвращает | string Пример: " https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token " |
Доступ | только для чтения |
Доступно в | Чтение камеры + изображения / v1-v4 Камера чтение/запись + изображения / v1-v4 |
activity_zone_ids
Идентификаторы зон активности, обнаруживших движение.
Требуется Nest Aware . При использовании с массивом activity_zones
вы можете получить имя зоны из этих идентификаторов.
-
true
= возвращает идентификаторы зон активности, которые обнаружили событие движения -
false
= возвращает пустой массив
Подробности | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/activity_zone_ids | |
Возвращает | array Пример: [ string1 , string2 ,... ] |
Доступ | только для чтения |
Доступно в | Чтение камеры + изображения / v3-v4 Камера чтение/запись + изображения / v3-v4 |