La API de Nest funciona con todos los modelos de Nest CamTM.
Los usuarios pueden agregar varias Nest Cams al grupo devices/cameras
, hasta el máximo por estructura.
Cuando llamas a esta ubicación de datos, puedes acceder a los datos de la Nest Cam (valores de datos para los dispositivos en la estructura).
Los siguientes valores se encuentran en cada devices/cameras/device_id
del documento JSON.
id_dispositivo
Identificador único de Nest Cam
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/device_id |
|
Qué muestra | string Ejemplo: "awJo6rH..." |
Acceso | solo lectura |
Disponible en | Lectura de la cámara / v1-v3 Lectura y imágenes de la cámara / v1-v4 Lectura/escritura de la cámara / v1-v3 Lectura/escritura de la cámara + imágenes / v1-v4 |
versión_software
Versión de software.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/software_version |
|
Qué muestra | string Ejemplo: 4.0" |
Acceso | solo lectura |
Disponible en | Lectura de la cámara/v1-v3 Lectura y imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3 Lectura/escritura de la cámara + imágenes/v1-v4 |
Estructura_id
Identificador único de la estructura.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/structure_id |
|
Qué muestra | string Ejemplo: &qtFbWH21nw... |
Acceso | solo lectura |
Disponible en | Lectura de la cámara / v1-v3 Lectura y imágenes de la cámara / v1-v4 Lectura/escritura de la cámara / v1-v3 Lectura/escritura de la cámara + imágenes / v1-v4 |
dónde_id
Un identificador único generado por Nest que representa a name
, el nombre visible del dispositivo.
Obtén más información sobre los nombres de los Nest Thermostat, los Nest Protect y las Nest Cams.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/where_id |
|
Qué muestra | string Ejemplo: "d6reb_OZTM... |
Acceso | solo lectura |
Disponible en | Lectura de la cámara / v1-v3 Lectura y imágenes de la cámara / v1-v4 Lectura/escritura de la cámara / v1-v3 Lectura/escritura de la cámara + imágenes / v1-v4 |
dónde_nombre
El nombre visible del dispositivo Se asocia con la 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 Nest Thermostat, los Nest Protect y las Nest Cams.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/where_name |
|
Qué muestra | string Ejemplo: "Pasillo" |
Acceso | solo lectura |
Disponible en | Lectura de la cámara / v3 Lectura y imágenes de la cámara / v4 Lectura/escritura de la cámara / v3 Lectura/escritura de la cámara + imágenes / v4 |
name
Nombre visible 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 |
|
Qué muestra | string Ejemplo: "Pasillo" |
Acceso | solo lectura |
Disponible en | Lectura de la cámara/v1-v3 Lectura y imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3 Lectura/escritura de la cámara + imágenes/v1-v4 |
nombre_largo
El nombre visible completo del dispositivo. Incluye una etiqueta personalizada (etiqueta), creada por el usuario o a través de wheres
.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/name_long |
|
Qué muestra | string Ejemplo: Nest Cam (en la planta alta)" |
Acceso | solo lectura |
Disponible en | Lectura de la cámara / v1-v3 Lectura y imágenes de la cámara / v1-v4 Lectura/escritura de la cámara / v1-v3 Lectura/escritura de la cámara + imágenes / v1-v4 |
está_en_línea
Estado de la conexión del dispositivo con el servicio de Nest.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/is_online |
|
Qué muestra | boolean Valores: true, false |
Acceso | solo lectura |
Disponible en | Lectura de la cámara/v1-v3 Lectura y imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3 Lectura/escritura de la cámara + imágenes/v1-v4 |
is_streaming
Estado de la cámara, tanto encendida como en transmisión de video activa. Para obtener más información, consulta Cómo funciona la cámara con la Función En casa/Ausente.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/is_streaming |
|
Qué muestra | boolean Valores: true, false |
Acceso | Lectura y escritura |
Disponible en | Lectura de la cámara / v1-v3 Lectura y imágenes de la cámara / v1-v4 Lectura/escritura de la cámara / v1-v3 Lectura/escritura de la cámara + imágenes / v1-v4 |
is_audio_input_enabled
Estado del micrófono de la cámara, ya sea activado o desactivado, o desactivado. Obtén más información sobre la configuración de audio de la Nest Cam.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/is_audio_input_enabled |
|
Qué muestra | boolean Valores: true, false |
Acceso | solo lectura |
Disponible en | Lectura de la cámara/v1-v3 Lectura y imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3 Lectura/escritura de la cámara + imágenes/v1-v4 |
último_cambio_en_línea
Marca de tiempo que identifica el último cambio en el estado de conexión, en formato ISO 8601.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_is_online_change |
|
Qué muestra | string Ejemplo: "2016-12-29T18:42:00.000Z" |
Acceso | solo lectura |
Disponible en | Lectura de la cámara/v1-v3 Lectura y imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3 Lectura/escritura de la cámara + imágenes/v1-v4 |
is_video_history_enabled
Estado de la suscripción a Nest Aware (activa o no)
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/is_video_history_enabled |
|
Qué muestra | boolean Valores: true, false |
Acceso | solo lectura |
Disponible en | Lectura de la cámara / v1-v3 Lectura y imágenes de la cámara / v1-v4 Lectura/escritura de la cámara / v1-v3 Lectura/escritura de la cámara + imágenes / v1-v4 |
URL_web
URL web (vínculo directo) a la transmisión de video en vivo en home.nest.com.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/web_url |
|
Qué muestra | string Ejemplo: " https://home.nest.com/cameras/device_id?auth=camera_token " |
Acceso | solo lectura |
Disponible en | Lectura de la cámara / v1-v3 Lectura y imágenes de la cámara / v1-v4 Lectura/escritura de la cámara / v1-v3 Lectura/escritura de la cámara + imágenes / v1-v4 |
URL de la aplicación
URL de la app (vínculo directo) a la transmisión de video en vivo en la app de Nest.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/app_url |
|
Qué muestra | string Ejemplo: " nestmobile://cameras/device_id?auth=camera_token " |
Acceso | solo lectura |
Disponible en | Lectura de la cámara/v1-v3 Lectura y imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3 Lectura/escritura de la cámara + imágenes/v1-v4 |
is_public_share_enabled
Los usuarios pueden compartir su video y hacerlo visible para cualquier persona. Cuando la función de uso compartido público está habilitada, puedes leer public_share_url
.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/is_public_share_enabled |
|
Qué muestra | boolean Valores: true, false |
Acceso | solo lectura |
Disponible en | Lectura de la cámara + imágenes / v3-v4 Lectura/escritura de la cámara + imágenes / v3-v4 |
zonas_de_actividad
Muestra un arreglo de todas las zonas de actividad definidas.
Las zonas de actividad se usan para supervisar los eventos de movimiento dentro de las áreas definidas por el usuario de la transmisión de video por Internet. Requiere Nest Aware.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/activity_zones |
|
Qué muestra | array Ejemplo: [ {"name" : "string1", "id" : "string2"},... ] • string1 es el nombre de la zona definida por el usuario o que se genera automáticamente cuando se crea la zona.• string2 es un identificador que asigna Nest cuando se crea la zona de actividad. |
Acceso | solo lectura |
Disponible en | Lectura de la cámara + imágenes / v3-v4 Lectura/escritura de la cámara + imágenes / v3-v4 |
URL_compartida_pública
Puedes acceder a esta URL cuando un usuario realiza su transmisión de video pública.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/public_share_url |
|
Qué muestra | string Ejemplo: https://video.nest.com/live/string1?string2 string1 es el nombre de la transmisión de video por Internet, ya sea definido por el usuario o generado automáticamente cuando la transmisión se configura como pública. |
Acceso | solo lectura |
Disponible en | Lectura de la cámara + imágenes / v3-v4 Lectura/escritura de la cámara + imágenes / v3-v4 |
URL_instantánea
Capturar una imagen a pedido Muestra la URL de una imagen capturada de la transmisión de video en vivo. Requiere que la cámara esté encendida y transmitiendo contenido de forma activa.
Utilice este campo para obtener una instantánea de la transmisión de video en vivo.
snapshot_url
: Muestra la URL de una imagen capturada de la transmisión de video en vivo.- Requiere que la cámara esté encendida y transmitiendo contenido activamente.
La calidad de la instantánea de la API es solo de 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
) - te suscribiste a Nest Aware
Si no estás viendo la transmisión de forma activa o no tienes una suscripción a Nest Aware, la API no tiene una fuente de 1080p a partir de la cual recuperar una instantánea en esa resolución y generar 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 sea inferior a 1080 p con Nest Aware presente.
Obtén más información sobre los requisitos de ancho de banda para cámaras Nest.
Se aplican límites de frecuencia a esta llamada según el estado de suscripción de Nest Aware.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/snapshot_url |
|
Qué muestra | string Ejemplo: & string1/device_id/string2?auth=camera_token ; |
Acceso | solo lectura |
Disponible en | Lectura de la cámara + imágenes / v3-v4 Lectura/escritura de la cámara + imágenes / v3-v4 |
último_evento
Este objeto captura información sobre el último evento que activó 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.
Los siguientes valores se encuentran en cada devices/cameras/device_id/last_event
del documento JSON.
tiene_sonido
Evento de sonido: se detectó sonido.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/has_sound |
|
Qué muestra | boolean Valores: true, false |
Acceso | solo lectura |
Disponible en | Lectura de la cámara/v1-v3 Lectura y imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3 Lectura/escritura de la cámara + imágenes/v1-v4 |
has_motion
Evento de movimiento: se detectó movimiento.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/has_motion |
|
Qué muestra | boolean Valores: true, false |
Acceso | solo lectura |
Disponible en | Lectura de la cámara / v1-v3 Lectura y imágenes de la cámara / v1-v4 Lectura/escritura de la cámara / v1-v3 Lectura/escritura de la cámara + imágenes / v1-v4 |
tiene_persona
Evento de persona: se detectó una persona.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/has_person |
|
Qué muestra | boolean Valores: true, false |
Acceso | solo lectura |
Disponible en | Lectura de la cámara/v1-v3 Lectura y imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3 Lectura/escritura de la cámara + imágenes/v1-v4 |
hora_de_inicio
Es la hora de inicio del evento en formato ISO 8601.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/start_time |
|
Qué muestra | string Ejemplo: &2016-12-29T00:00:00.000Z" |
Acceso | solo lectura |
Disponible en | Lectura de la cámara/v1-v3 Lectura y imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3 Lectura/escritura de la cámara + imágenes/v1-v4 |
hora_de_finalización
Es la hora de finalización del evento en formato ISO 8601.
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/end_time |
|
Qué muestra | string Ejemplo: &2016-12-29T00:00:00.000Z" |
Acceso | solo lectura |
Disponible en | Lectura de la cámara/v1-v3 Lectura y imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3 Lectura/escritura de la cámara + imágenes/v1-v4 |
urls_expire_time
Marca de tiempo en formato ISO 8601 que identifica el vencimiento de estas URL relacionadas con eventos:
El tiempo de vencimiento se calcula de la siguiente manera: 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 |
|
Qué muestra | string Ejemplo: &2016-12-29T00:00:00.000Z" |
Acceso | solo lectura |
Disponible en | Lectura de la cámara / v1-v3 Lectura y imágenes de la cámara / v1-v4 Lectura/escritura de la cámara / v1-v3 Lectura/escritura de la cámara + imágenes / v1-v4 |
URL_web
URL web (vínculo directo) al último evento de sonido o movimiento en home.nest.com. Se usa para mostrar el último evento grabado y se requiere que el usuario haya accedido a la cuenta.
Requiere Nest Aware. Si la URL del evento venció o si el dispositivo no tiene una suscripción activa, este valor no se incluye en la carga útil.
Consulta 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 |
|
Qué muestra | string Ejemplo: " https://home.nest.com/cameras/device_id/cuepoints/string?auth=camera_token " |
Acceso | solo lectura |
Disponible en | Lectura de la cámara/v1-v3 Lectura y imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3 Lectura/escritura de la cámara + imágenes/v1-v4 |
URL de la aplicación
URL de la app de Nest (vínculo directo) al último evento de movimiento o sonido. Se usa para mostrar el último evento registrado y requiere que el usuario acceda a la cuenta.
Requiere Nest Aware. Si la URL del evento venció o si el dispositivo no tiene una suscripción activa, este valor no se incluye en la carga útil.
Consulta 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/app_url |
|
Qué muestra | string Ejemplo: " nestmobile://cameras/device_id/cuepoints/string?auth=camera_token " |
Acceso | solo lectura |
Disponible en | Lectura de la cámara/v1-v3 Lectura y imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3 Lectura/escritura de la cámara + imágenes/v1-v4 |
URL de imagen [image_url]
Es la URL (vínculo) al archivo de imagen capturado para un evento de sonido o movimiento.
Requiere Nest Aware. Consulta 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 |
|
Qué muestra | string Ejemplo: & https://www.dropcam.com/api/wwn.get_image/string1/device_id/string2?auth=camera_token ; |
Acceso | solo lectura |
Disponible en | Lectura de la cámara + imágenes / v1-v4 Lectura/escritura de la cámara + imágenes / v1-v4 |
URL_de_imagen_animada
Es la URL (vínculo) 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 |
|
Qué muestra | string Ejemplo: & https://www.dropcam.com/api/wwn.get_image/string1/device_id/string2?auth=camera_token ; |
Acceso | solo lectura |
Disponible en | Lectura de la cámara + imágenes / v1-v4 Lectura/escritura de la cámara + imágenes / v1-v4 |
ID de zona de actividad
Identificadores de las zonas de actividad que detectaron un evento de movimiento.
Requiere Nest Aware. Cuando se usa con el array activity_zones
, puedes obtener el nombre de la zona de estos ID.
Si last_event/has_motion
es
true
: Muestra los ID de la zona de actividad que detectaron un evento de movimiento.false
= muestra un arreglo vacío
Detalles | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/activity_zone_ids |
|
Qué muestra | array Ejemplo: [ string1, string2,... ] |
Acceso | solo lectura |
Disponible en | Lectura de la cámara + imágenes / v3-v4 Lectura/escritura de la cámara + imágenes / v3-v4 |