API камеры

Nest API работает со всеми моделями Nest Cam ™.

Пользователи могут добавлять несколько гнездовых devices/cameras группу 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 Камера читает + images / v1-v4 Камера для чтения / записи / v1-v3 Камера чтения / записи + изображения / v1-v4

Версия ПО

Версия ПО.

подробности
https://developer-api.nest.com/devices/cameras/ device_id /software_version
Возвращает	string Пример: "4.0"
доступ	только для чтения
Доступно в	Камера чтения / v1-v3 Камера читает + images / v1-v4 Камера для чтения / записи / v1-v3 Камера чтения / записи + изображения / v1-v4

structure_id

Уникальный идентификатор структуры.

подробности
https://developer-api.nest.com/devices/cameras/ device_id /structure_id
Возвращает	string Пример: "VqFabWH21nw ..."
доступ	только для чтения
Доступно в	Камера чтения / v1-v3 Камера читает + images / v1-v4 Камера для чтения / записи / v1-v3 Камера чтения / записи + изображения / v1-v4

where_id

Уникальный сгенерированный гнездом идентификатор, представляющий name , отображаемое имя устройства.

Узнайте больше о названиях термостатов Nest , Nest Protects и Nest Cams .

подробности
https://developer-api.nest.com/devices/cameras/ device_id /where_id
Возвращает	string Пример: "d6reb_OZTM ..."
доступ	только для чтения
Доступно в	Камера чтения / v1-v3 Камера читает + images / v1-v4 Камера для чтения / записи / v1-v3 Камера чтения / записи + изображения / v1-v4

where_name

Отображаемое имя устройства. Связанный с 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 Камера читает + images / v1-v4 Камера для чтения / записи / v1-v3 Камера чтения / записи + изображения / v1-v4

NAME_LONG

Длинное отображаемое имя устройства. Включает в себя пользовательский (метка), созданный пользователем или через wheres .

подробности
https://developer-api.nest.com/devices/cameras/ device_id /name_long
Возвращает	string Пример: "Прихожая Nest Cam (наверху)"
доступ	только для чтения
Доступно в	Камера чтения / v1-v3 Камера читает + images / v1-v4 Камера для чтения / записи / v1-v3 Камера чтения / записи + изображения / v1-v4

В сети

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

подробности
https://developer-api.nest.com/devices/cameras/ device_id /is_online
Возвращает	boolean Значения: правда, ложь
доступ	только для чтения
Доступно в	Камера чтения / v1-v3 Камера читает + images / 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 Камера читает + images / 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 Камера читает + images / 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 Камера читает + images / 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 Камера читает + images / 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 Камера читает + images / 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 Камера читает + images / v1-v4 Камера для чтения / записи / v1-v3 Камера чтения / записи + изображения / v1-v4

is_public_share_enabled

Пользователи могут поделиться своим видео и сделать его доступным для просмотра всем. Когда публичный общий public_share_url включен, вы можете прочитать public_share_url .

подробности
https://developer-api.nest.com/devices/cameras/ device_id /is_public_share_enabled
Возвращает	boolean Значения: правда, ложь
доступ	только для чтения
Доступно в	Камера читает + images / v3-v4 Камера для чтения / записи + images / v3-v4

activity_zones

Возвращает массив всех определенных зон активности.

Зоны активности используются для мониторинга событий движения в определенных пользователем областях видеопотока. Требуется Nest Aware .

подробности
https://developer-api.nest.com/devices/cameras/ device_id /activity_zones
Возвращает	array Пример: [ {"name" : " string1 ", "id" : " string2 "},... ] • string1 - это имя зоны, определяемое пользователем или автоматически генерируемое при создании зоны. • string2 - это идентификатор, назначенный Nest при создании зоны активности.
доступ	только для чтения
Доступно в	Камера читает + images / v3-v4 Камера для чтения / записи + images / 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 - это имя видеопотока, определяемое пользователем или автоматически генерируемое, когда для потока установлено значение public.
доступ	только для чтения
Доступно в	Камера читает + images / v3-v4 Камера для чтения / записи + images / 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 Aware.

подробности
https://developer-api.nest.com/devices/cameras/ device_id /snapshot_url
Возвращает	string Пример: " string1 / device_id / string2 ?auth= camera_token "
доступ	только для чтения
Доступно в	Камера читает + images / v3-v4 Камера для чтения / записи + images / 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 Камера читает + images / v1-v4 Камера для чтения / записи / v1-v3 Камера чтения / записи + изображения / v1-v4

has_motion

Событие движения - движение обнаружено.

подробности
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_motion
Возвращает	boolean Значения: правда, ложь
доступ	только для чтения
Доступно в	Камера чтения / v1-v3 Камера читает + images / v1-v4 Камера для чтения / записи / v1-v3 Камера чтения / записи + изображения / v1-v4

has_person

Событие человека - человек был обнаружен.

подробности
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_person
Возвращает	boolean Значения: правда, ложь
доступ	только для чтения
Доступно в	Камера чтения / v1-v3 Камера читает + images / 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 Камера читает + images / 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 Камера читает + images / v1-v4 Камера для чтения / записи / v1-v3 Камера чтения / записи + изображения / v1-v4

urls_expire_time

Отметка времени в формате ISO 8601 , которая определяет срок действия этих URL-адресов, связанных с событиями:

• last_event/web_url
• last_event/app_url
• last_event/image_url
• last_event/animated_image_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 Камера читает + images / 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 Камера читает + images / v1-v4 Камера для чтения / записи / v1-v3 Камера чтения / записи + изображения / v1-v4

APP_URL

URL приложения вложения (глубокая ссылка) для последнего события звука или движения Используется для отображения последнего записанного события и требует входа пользователя в учетную запись.

Требуется 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 Камера читает + images / 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 »
доступ	только для чтения
Доступно в	Камера читает + images / v1-v4 Камера чтения / записи + изображения / v1-v4

animated_image_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 »
доступ	только для чтения
Доступно в	Камера читает + images / v1-v4 Камера чтения / записи + изображения / v1-v4

activity_zone_ids

Идентификаторы для зон активности, которые обнаружили событие движения.

Требуется Nest Aware . При использовании с массивом activity_zones вы можете получить имя зоны из этих идентификаторов.

Если last_event/has_motion

• true = возвращает идентификаторы зоны активности, которые обнаружили событие движения
• false = возвращает пустой массив

подробности
https://developer-api.nest.com/devices/cameras/ device_id /last_event/activity_zone_ids
Возвращает	array Пример: [ string1 , string2 ,... ]
доступ	только для чтения
Доступно в	Камера читает + images / v3-v4 Камера для чтения / записи + images / v3-v4