La API de Nest funciona con todos los modelos de Nest Cam ™.
Los usuarios pueden agregar múltiples Nest Cam al grupo de devices/cameras
, hasta el máximo por estructura . Cuando realiza una llamada a esta ubicación de datos, puede acceder a los datos de Nest Cam (valores de datos para dispositivos en la estructura).
Todos los valores siguientes se encuentran en cada devices/cameras/ device_id
en el documento JSON.
Identificación del dispositivo
Identificador único de Nest Cam.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /device_id | |
Devoluciones | string Ejemplo: "awJo6rH ..." |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
Versión del software
Versión del software.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /software_version | |
Devoluciones | string Ejemplo: "4.0" |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
structure_id
Identificador único de estructura.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /structure_id | |
Devoluciones | string Ejemplo: "VqFabWH21nw ..." |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
where_id
Un identificador único generado por Nest que representa el name
, el nombre para mostrar del dispositivo.
Obtén más información sobre los nombres de los termostatosNest ,Nest Protects y Nest Cams .
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /where_id | |
Devoluciones | string Ejemplo: "d6reb_OZTM ..." |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
where_name
El nombre para mostrar del dispositivo. Asociado con Nest Cam where_id
. Puede ser cualquier nombre de habitación de una lista que proporcionamos o un nombre personalizado. Obtén más información sobre los nombres de los termostatosNest ,Nest Protects y Nest Cams .
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /where_name | |
Devoluciones | string Ejemplo: "Pasillo" |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v3 Cámara + lectura + imágenes / v4 Lectura / escritura de cámara / v3 Lectura / escritura de cámara + imágenes / v4 |
nombre
Nombre para mostrar del dispositivo; puede ser cualquier nombre de habitación de una lista que proporcionamos o un nombre personalizado.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /name | |
Devoluciones | string Ejemplo: "Pasillo" |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
name_long
Nombre de visualización largo del dispositivo. Incluye una (etiqueta) personalizada, creada por el usuario o a través de wheres
.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /name_long | |
Devoluciones | string Ejemplo: "Pasillo Nest Cam (arriba)" |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
está en linea
Estado de conexión del dispositivo con el servicio Nest.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_online | |
Devoluciones | boolean Valores: verdadero, falso |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
is_streaming
Estado de la cámara, ya sea encendida y transmitiendo video activamente, o apagada. Consulta Cómo funciona tu cámara con el Asistente En casa / Ausente para obtener más información.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_streaming | |
Devoluciones | boolean Valores: verdadero, falso |
Acceso | leer escribir |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
is_audio_input_enabled
Estado del micrófono de la cámara, ya sea encendido, escuchando o apagado. Obtén más información sobre la configuración de audio de Nest Cam .
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_audio_input_enabled | |
Devoluciones | boolean Valores: verdadero, falso |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
last_is_online_change
Marca de tiempo que identifica el último cambio en el estado en línea, en formato ISO 8601 .
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_is_online_change | |
Devoluciones | string Ejemplo: "2016-12-29T18: 42: 00.000Z" |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
is_video_history_enabled
Estado de la suscripción a Nest Aware (suscripción activa o no).
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_video_history_enabled | |
Devoluciones | boolean Valores: verdadero, falso |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
web_url
URL web (enlace profundo) a la transmisión de video en vivo en home.nest.com .
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /web_url | |
Devoluciones | string Ejemplo: " https://home.nest.com/cameras/ device_id ?auth= camera_token " |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
app_url
URL de la aplicación (enlace profundo) a la transmisión de video en vivo en la aplicación Nest.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /app_url | |
Devoluciones | string Ejemplo: " nestmobile://cameras/ device_id ?auth= camera_token " |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
is_public_share_enabled
Los usuarios pueden optar por compartir su video y hacerlo visible para cualquier persona. Cuando el uso compartido público está habilitado, puede leer public_share_url
.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_public_share_enabled | |
Devoluciones | boolean Valores: verdadero, falso |
Acceso | solo lectura |
Disponible en | Cámara + lectura + imágenes / v3-v4 Lectura / escritura + imágenes de la cámara / v3-v4 |
activity_zones
Devuelve una matriz de todas las Zonas de actividad definidas.
Las zonas de actividad se utilizan para monitorear eventos de movimiento dentro de áreas definidas por el usuario de la transmisión de video. Requiere Nest Aware .
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /activity_zones | |
Devoluciones | array Ejemplo: [ {"name" : " string1 ", "id" : " string2 "},... ] • string1 es el nombre de la zona, ya sea definido por el usuario o generado automáticamente cuando se crea la zona.• string2 es un identificador asignado por Nest cuando se crea la Zona de actividad. |
Acceso | solo lectura |
Disponible en | Cámara + lectura + imágenes / v3-v4 Lectura / escritura + imágenes de la cámara / v3-v4 |
public_share_url
Puede acceder a esta URL cuando un usuario hace pública su transmisión de video .
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /public_share_url | |
Devoluciones | string Ejemplo: " https://video.nest.com/live/ string1 ? string2 "string1 es el nombre del flujo de video, ya sea definido por el usuario o generado automáticamente cuando el flujo se establece en público. |
Acceso | solo lectura |
Disponible en | Cámara + lectura + imágenes / v3-v4 Lectura / escritura + imágenes de la cámara / v3-v4 |
snapshot_url
Capture una imagen a pedido. Devuelve la URL de una imagen capturada de la transmisión de video en vivo. Requiere que la cámara esté encendida y transmitiendo activamente.
Utilice este campo para obtener una instantánea de la transmisión de video en vivo.
-
snapshot_url
: devuelve la URL de una imagen capturada de la transmisión de video en vivo - Requiere que la cámara esté encendida y transmitiendo activamente
La calidad de la instantánea de la API es de solo 1080p si:
- ver activamente la transmisión de la cámara en la aplicación (
web_url
) - viendo activamente la transmisión pública (
app_url
) - suscrito a Nest Aware
Si no está viendo activamente la transmisión o no tiene una suscripción a Nest Aware, la API no tiene una fuente de 1080p desde la cual recuperar una instantánea con esa resolución y genera una imagen de menor calidad. Además, un ancho de banda de red local bajo puede hacer que la resolución de la instantánea de la API caiga por debajo de 1080p con Nest Aware presente.
Obtén más información sobre los requisitos de ancho de banda para las cámaras Nest .
Se aplican límites de tarifa a esta llamada, según el estado de la suscripción a Nest Aware.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /snapshot_url | |
Devoluciones | string Ejemplo: " string1 / device_id / string2 ?auth= camera_token " |
Acceso | solo lectura |
Disponible en | Cámara + lectura + imágenes / v3-v4 Lectura / escritura + imágenes de la cámara / v3-v4 |
último evento
Este objeto captura información sobre el último evento que provocó una notificación.
Algunos campos y algunas combinaciones de permisos requieren una suscripción a Nest Aware para acceder a la información del último evento.
Todos los valores siguientes se encuentran en cada devices/cameras/ device_id /last_event
en el documento JSON.
has_sound
Evento de sonido: se detectó sonido.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_sound | |
Devoluciones | boolean Valores: verdadero, falso |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
has_motion
Evento de movimiento: se detectó movimiento.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_motion | |
Devoluciones | boolean Valores: verdadero, falso |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
has_person
Evento de persona: se detectó una persona.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_person | |
Devoluciones | boolean Valores: verdadero, falso |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
hora de inicio
Hora de inicio del evento, en formato ISO 8601 .
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/start_time | |
Devoluciones | string Ejemplo: "2016-12-29T00: 00: 00.000Z" |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
hora de finalización
Hora de finalización del evento, en formato ISO 8601 .
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/end_time | |
Devoluciones | string Ejemplo: "2016-12-29T00: 00: 00.000Z" |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
urls_expire_time
Marca de tiempo, en formato ISO 8601 , que identifica la expiración de estas URL relacionadas con eventos:
El tiempo de vencimiento se calcula como: last_event/start_time
+ n días (donde n = 10 o 30 días, según el plan de suscripción de Nest Aware).
Requiere Nest Aware .
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/urls_expire_time | |
Devoluciones | string Ejemplo: "2016-12-29T00: 00: 00.000Z" |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
web_url
URL web (enlace profundo) al último evento de sonido o movimiento en home.nest.com . Se utiliza para mostrar el último evento registrado y requiere que el usuario inicie sesión en la cuenta.
Requiere Nest Aware . Si la URL del evento ha caducado o el dispositivo no tiene una suscripción activa, este valor no se incluye en la carga útil.
Consulte last_event/urls_expire_time
para obtener información sobre el tiempo de vencimiento de esta URL.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/web_url | |
Devoluciones | string Ejemplo: " https://home.nest.com/cameras/ device_id /cuepoints/ string ?auth= camera_token " |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
app_url
URL de la aplicación Nest (enlace profundo) al último evento de sonido o movimiento. Se utiliza para mostrar el último evento registrado y requiere que el usuario inicie sesión en la cuenta.
Requiere Nest Aware . Si la URL del evento ha caducado o el dispositivo no tiene una suscripción activa, este valor no se incluye en la carga útil.
Consulte last_event/urls_expire_time
para obtener información sobre la fecha de vencimiento de esta URL.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/app_url | |
Devoluciones | string Ejemplo: " nestmobile://cameras/ device_id /cuepoints/ string ?auth= camera_token " |
Acceso | solo lectura |
Disponible en | Lectura de cámara / v1-v3 Cámara + lectura + imágenes / v1-v4 Lectura / escritura de cámara / v1-v3 Lectura / escritura + imágenes de la cámara / v1-v4 |
URL de la imagen
URL (enlace) al archivo de imagen capturado para un evento de sonido o movimiento.
Requiere Nest Aware . Consulte last_event/urls_expire_time
para obtener información sobre el tiempo de vencimiento de esta URL.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/image_url | |
Devoluciones | string Ejemplo: " https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token " |
Acceso | solo lectura |
Disponible en | Cámara + lectura + imágenes / v1-v4 Lectura / escritura + imágenes de la cámara / v1-v4 |
url_imagen_animada
URL (enlace) al archivo gif capturado para un evento de sonido o movimiento.
Requiere Nest Aware .
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/animated_image_url | |
Devoluciones | string Ejemplo: " https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token " |
Acceso | solo lectura |
Disponible en | Cámara + lectura + imágenes / v1-v4 Lectura / escritura + imágenes de la cámara / v1-v4 |
activity_zone_ids
Identificadores para zonas de actividad que detectaron un evento de movimiento.
Requiere Nest Aware . Cuando se usa con la matriz activity_zones
, puede obtener el nombre de la zona a partir de estos identificadores.
Si last_event/has_motion
es
-
true
= devuelve los ID de la zona de actividad que detectaron un evento de movimiento -
false
= devuelve una matriz vacía
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/activity_zone_ids | |
Devoluciones | array Ejemplo: [ string1 , string2 ,... ] |
Acceso | solo lectura |
Disponible en | Cámara + lectura + imágenes / v3-v4 Lectura / escritura + imágenes de la cámara / v3-v4 |