API Camera

L'API Nest est compatible avec tous les modèles de Nest CamTM.

Les utilisateurs peuvent ajouter plusieurs Nest Cam au groupe devices/cameras, dans la limite du nombre maximal par structure. Lorsque vous appelez la localisation de vos données, vous avez accès aux données de la Nest Cam (valeurs des données pour les appareils de la structure).

Toutes les valeurs ci-dessous sont situées sous chaque devices/cameras/device_id dans le document JSON.

device_id [id_appareil]

Identifiant unique de la Nest Cam.

Détails
https://developer-api.nest.com/devices/cameras/device_id/device_id
Renvoiestring
Exemple: "awJo6rH..."
Accèslecture seule
Disponible enAppareil photo lu/V1-v3
Lecture appareil photo+images/v1-v4
Lecture/écriture appareil photo/v1-v3
Lecture/écriture + images/V1-v4

version_logicielle

Version logicielle.

Détails
https://developer-api.nest.com/devices/cameras/device_id/software_version
Renvoiestring
Exemple : "4,0"
Accèslecture seule
Disponible enAppareil photo lu/V1-v3
Lecture appareil photo+images/v1-v4
Lecture/écriture appareil photo/v1-v3
Lecture/écriture + images/V1-v4

structure_id [id_structure]

Identifiant unique de la structure.

Détails
https://developer-api.nest.com/devices/cameras/device_id/structure_id
Renvoiestring
Exemple : VqFabWH21nw..."
Accèslecture seule
Disponible enAppareil photo lu / V1-v3
Lecture appareil photo+images / v1-v4
Lecture/écriture appareil photo / v1-v3
Lecture/écriture + images / V1-v4

Où_id

Identifiant unique généré par Nest, qui représente name, le nom à afficher de l'appareil.

En savoir plus sur l'emplacement des différentes versions des thermostats Nest, des Nest Protect et des Nest Cam

Détails
https://developer-api.nest.com/devices/cameras/device_id/where_id
Renvoiestring
Exemple: &dtrere_OZTM...
Accèslecture seule
Disponible enAppareil photo lu / V1-v3
Lecture appareil photo+images / v1-v4
Lecture/écriture appareil photo / v1-v3
Lecture/écriture + images / V1-v4

nom_où

Nom à afficher de l'appareil. Associé à la Nest Cam where_id. Vous pouvez utiliser n'importe quel nom de chambre dans une liste que nous fournissons ou un nom personnalisé. En savoir plus sur l'emplacement des différentes versions des thermostats Nest, des Nest Protect et des Nest Cam

Détails
https://developer-api.nest.com/devices/cameras/device_id/where_name
Renvoiestring
Exemple : Couloir
Accèslecture seule
Disponible enAppareil photo lu / v3
Caméra lue + images / v4
Appareil photo/écriture / v3
Lecture/Écriture + images / V4

name

Nom à afficher de l'appareil. Il peut s'agir de n'importe quel nom de pièce dans une liste fournie ou d'un nom personnalisé.

Détails
https://developer-api.nest.com/devices/cameras/device_id/name
Renvoiestring
Exemple : Couloir
Accèslecture seule
Disponible enAppareil photo lu/V1-v3
Lecture appareil photo+images/v1-v4
Lecture/écriture appareil photo/v1-v3
Lecture/écriture + images/V1-v4

nom_long

Nom à afficher long de l'appareil. Comprend un (libellé) personnalisé créé par l'utilisateur ou via wheres.

Détails
https://developer-api.nest.com/devices/cameras/device_id/name_long
Renvoiestring
Exemple : "Nest Cam Hall d'entrée (étage)"
Accèslecture seule
Disponible enAppareil photo lu/V1-v3
Lecture appareil photo+images/v1-v4
Lecture/écriture appareil photo/v1-v3
Lecture/écriture + images/V1-v4

en ligne

État de la connexion de l'appareil avec le service Nest.

Détails
https://developer-api.nest.com/devices/cameras/device_id/is_online
Renvoieboolean
Valeurs: true, false
Accèslecture seule
Disponible enAppareil photo lu/V1-v3
Lecture appareil photo+images/v1-v4
Lecture/écriture appareil photo/v1-v3
Lecture/écriture + images/V1-v4

is_streaming [is_streaming]

État de la caméra, soit en mode vidéo active, en mode actif, soit désactivé. Pour plus d'informations, consultez la section Comprendre comment la caméra utilise la fonction Chez moi/Absent.

Détails
https://developer-api.nest.com/devices/cameras/device_id/is_streaming
Renvoieboolean
Valeurs: true, false
Accèslecture/écriture
Disponible enAppareil photo lu / V1-v3
Lecture appareil photo+images / v1-v4
Lecture/écriture appareil photo / v1-v3
Lecture/écriture + images / V1-v4

is_audio_input_enabled

État du micro de la caméra, activé ou désactivé, ou désactivé. En savoir plus sur les paramètres audio de la Nest Cam

Détails
https://developer-api.nest.com/devices/cameras/device_id/is_audio_input_enabled
Renvoieboolean
Valeurs: true, false
Accèslecture seule
Disponible enAppareil photo lu / V1-v3
Lecture appareil photo+images / v1-v4
Lecture/écriture appareil photo / v1-v3
Lecture/écriture + images / V1-v4

Dernière modification en ligne

Horodatage indiquant la dernière modification de l'état de connexion, au format ISO 8601.

Détails
https://developer-api.nest.com/devices/cameras/device_id/last_is_online_change
Renvoiestring
Exemple : "2016-12-29T18:42:00.000Z&quot"
Accèslecture seule
Disponible enAppareil photo lu / V1-v3
Lecture appareil photo+images / v1-v4
Lecture/écriture appareil photo / v1-v3
Lecture/écriture + images / V1-v4

is_video_history_enabled

État de l'abonnement Nest Aware (actif ou non)

Détails
https://developer-api.nest.com/devices/cameras/device_id/is_video_history_enabled
Renvoieboolean
Valeurs: true, false
Accèslecture seule
Disponible enAppareil photo lu / V1-v3
Lecture appareil photo+images / v1-v4
Lecture/écriture appareil photo / v1-v3
Lecture/écriture + images / V1-v4

URL_Web

URL Web (lien profond) vers le flux vidéo en direct à l'adresse home.nest.com.

Détails
https://developer-api.nest.com/devices/cameras/device_id/web_url
Renvoiestring
Exemple :https://home.nest.com/cameras/device_id?auth=camera_token"
Accèslecture seule
Disponible enAppareil photo lu/V1-v3
Lecture appareil photo+images/v1-v4
Lecture/écriture appareil photo/v1-v3
Lecture/écriture + images/V1-v4

URL_application

URL de l'application (lien profond) vers le flux vidéo en direct dans l'application Nest.

Détails
https://developer-api.nest.com/devices/cameras/device_id/app_url
Renvoiestring
Exemple :nestmobile://cameras/device_id?auth=camera_token"
Accèslecture seule
Disponible enAppareil photo lu/V1-v3
Lecture appareil photo+images/v1-v4
Lecture/écriture appareil photo/v1-v3
Lecture/écriture + images/V1-v4

is_public_share_enabled

Les utilisateurs peuvent choisir de partager leur vidéo et de la rendre visible par tout le monde. Lorsque le partage public est activé, vous pouvez lire public_share_url.

Détails
https://developer-api.nest.com/devices/cameras/device_id/is_public_share_enabled
Renvoieboolean
Valeurs: true, false
Accèslecture seule
Disponible enAppareil photo + lecture / images / v3-v4
Lecture/Écriture + images / v3-v4

zones d'activité

Affiche un tableau de toutes les zones d'activité définies.

Les zones d'activité permettent de surveiller les événements de mouvement dans les zones définies par le flux vidéo. Nécessite Nest Aware.

Détails
https://developer-api.nest.com/devices/cameras/device_id/activity_zones
Renvoiearray
Exemple: [ {"name" : "string1", "id" : "string2"},... ]

string1 est le nom de la zone, défini par l'utilisateur ou généré automatiquement lors de sa création.
string2 est un identifiant attribué par Nest lors de la création de la zone d'activité.
Accèslecture seule
Disponible enAppareil photo + lecture / images / v3-v4
Lecture/Écriture + images / v3-v4

public_share_url

Vous pouvez accéder à cette URL lorsqu'un utilisateur rend son flux vidéo public.

Détails
https://developer-api.nest.com/devices/cameras/device_id/public_share_url
Renvoiestring
Exemple : ""

string1"est le nom du flux vidéo, défini par l'utilisateur ou généré automatiquement lorsque le flux est défini comme public.
Accèslecture seule
Disponible enAppareil photo + lecture / images / v3-v4
Lecture/Écriture + images / v3-v4

URL_instantanée

Capturez une image à la demande. Renvoie l'URL d'une image capturée à partir du flux vidéo en direct. Nécessite que la caméra soit allumée et diffuse un flux actif.

Ce champ vous permet d'obtenir un instantané du flux vidéo en direct.

  • snapshot_url : affiche l'URL d'une image capturée à partir du flux vidéo en direct.
  • Nécessite que la caméra soit allumée et diffuse un flux actif

Le débit d'instantané de l'API est de 1080p uniquement si vous:

  • Affichage actif du flux de la caméra dans l'application (web_url)
  • qui consulte activement le flux public (app_url)
  • abonné à Nest Aware

Si vous ne regardez pas activement le flux ou que vous n'avez pas d'abonnement Nest Aware, l'API ne dispose pas d'une source 1080p à partir de laquelle récupérer un instantané à cette résolution et génère une image de moins bonne qualité. Par ailleurs, une faible bande passante réseau locale peut entraîner une baisse de la résolution des instantanés d'API inférieure à 1080p avec Nest Aware.

En savoir plus sur la bande passante requise pour les caméras Nest

Les limites de débit s'appliquent à cet appel, en fonction de l'état de l'abonnement Nest Aware.

Détails
https://developer-api.nest.com/devices/cameras/device_id/snapshot_url
Renvoiestring
Exemple : "string1/device_id/string2?auth=camera_token"
Accèslecture seule
Disponible enAppareil photo + lecture / images / v3-v4
Lecture/Écriture + images / v3-v4

dernier_événement

Cet objet capture des informations sur le dernier événement ayant déclenché une notification.

Certains champs et certaines combinaisons d'autorisations nécessitent un abonnement Nest Aware pour accéder aux informations du dernier événement.

Toutes les valeurs ci-dessous sont situées sous chaque devices/cameras/device_id/last_event du document JSON.

has_sound

Événement sonore : un son a été détecté.

Détails
https://developer-api.nest.com/devices/cameras/device_id/last_event/has_sound
Renvoieboolean
Valeurs: true, false
Accèslecture seule
Disponible enAppareil photo lu/V1-v3
Lecture appareil photo+images/v1-v4
Lecture/écriture appareil photo/v1-v3
Lecture/écriture + images/V1-v4

Has_motion

Événement de mouvement : un mouvement a été détecté.

Détails
https://developer-api.nest.com/devices/cameras/device_id/last_event/has_motion
Renvoieboolean
Valeurs: true, false
Accèslecture seule
Disponible enAppareil photo lu/V1-v3
Lecture appareil photo+images/v1-v4
Lecture/écriture appareil photo/v1-v3
Lecture/écriture + images/V1-v4

a_personne

Événement relatif à une personne : une personne a été détectée.

Détails
https://developer-api.nest.com/devices/cameras/device_id/last_event/has_person
Renvoieboolean
Valeurs: true, false
Accèslecture seule
Disponible enAppareil photo lu / V1-v3
Lecture appareil photo+images / v1-v4
Lecture/écriture appareil photo / v1-v3
Lecture/écriture + images / V1-v4

start_time

Heure de début de l'événement, au format ISO 8601.

Détails
https://developer-api.nest.com/devices/cameras/device_id/last_event/start_time
Renvoiestring
Exemple : "2016-12-29T00:00:00.000Z"
Accèslecture seule
Disponible enAppareil photo lu / V1-v3
Lecture appareil photo+images / v1-v4
Lecture/écriture appareil photo / v1-v3
Lecture/écriture + images / V1-v4

end_time

Heure de fin de l'événement, au format ISO 8601.

Détails
https://developer-api.nest.com/devices/cameras/device_id/last_event/end_time
Renvoiestring
Exemple : "2016-12-29T00:00:00.000Z"
Accèslecture seule
Disponible enAppareil photo lu / V1-v3
Lecture appareil photo+images / v1-v4
Lecture/écriture appareil photo / v1-v3
Lecture/écriture + images / V1-v4

urls_expire_time [URL_expiration_url]

Horodatage au format ISO 8601, qui identifie l'expiration de ces URL d'événement:

Le délai d'expiration est calculé comme suit : last_event/start_time + n jours (où n = 10 ou 30 jours, selon le abonnement Nest Aware).

Nécessite Nest Aware.

Détails
https://developer-api.nest.com/devices/cameras/device_id/last_event/urls_expire_time
Renvoiestring
Exemple : "2016-12-29T00:00:00.000Z"
Accèslecture seule
Disponible enAppareil photo lu / V1-v3
Lecture appareil photo+images / v1-v4
Lecture/écriture appareil photo / v1-v3
Lecture/écriture + images / V1-v4

URL_Web

URL Web (lien profond) vers le dernier événement sonore ou de mouvement sur home.nest.com. Permet d'afficher le dernier événement enregistré et nécessite que l'utilisateur soit connecté au compte.

Nécessite Nest Aware. Si l'URL de l'événement a expiré ou que l'appareil n'a pas d'abonnement actif, cette valeur n'est pas incluse dans la charge utile.

Pour en savoir plus sur le délai d'expiration de cette URL, consultez last_event/urls_expire_time.

Détails
https://developer-api.nest.com/devices/cameras/device_id/last_event/web_url
Renvoiestring
Exemple :https://home.nest.com/cameras/device_id/cuepoints/string?auth=camera_token"
Accèslecture seule
Disponible enAppareil photo lu / V1-v3
Lecture appareil photo+images / v1-v4
Lecture/écriture appareil photo / v1-v3
Lecture/écriture + images / V1-v4

URL_application

URL de l'application Nest (lien profond) vers le dernier événement de son ou de mouvement. Permet d'afficher le dernier événement enregistré et nécessite que l'utilisateur soit connecté au compte.

Nécessite Nest Aware. Si l'URL de l'événement a expiré ou que l'appareil n'a pas d'abonnement actif, cette valeur n'est pas incluse dans la charge utile.

Pour en savoir plus sur le délai d'expiration de cette URL, consultez last_event/urls_expire_time.

Détails
https://developer-api.nest.com/devices/cameras/device_id/last_event/app_url
Renvoiestring
Exemple :nestmobile://cameras/device_id/cuepoints/string?auth=camera_token"
Accèslecture seule
Disponible enAppareil photo lu/V1-v3
Lecture appareil photo+images/v1-v4
Lecture/écriture appareil photo/v1-v3
Lecture/écriture + images/V1-v4

URL_image

URL (lien) du fichier image capturé pour un événement sonore ou de mouvement.

Nécessite Nest Aware. Pour en savoir plus sur le délai d'expiration de cette URL, consultez last_event/urls_expire_time.

Détails
https://developer-api.nest.com/devices/cameras/device_id/last_event/image_url
Renvoiestring
Exemple : "https://www.dropcam.com/api/wwn.get_image/string1/device_id/string2?auth=camera_token"
Accèslecture seule
Disponible enAppareil photo + lecture / images / v1-v4
Lecture/Écriture + images / v1-v4

animée_image_url

URL (lien) vers le fichier GIF capturé pour un événement de son ou de mouvement.

Nécessite Nest Aware.

Détails
https://developer-api.nest.com/devices/cameras/device_id/last_event/animated_image_url
Renvoiestring
Exemple : "https://www.dropcam.com/api/wwn.get_image/string1/device_id/string2?auth=camera_token"
Accèslecture seule
Disponible enAppareil photo + lecture / images / v1-v4
Lecture/Écriture + images / v1-v4

ID_zone_activité

Identifiants des zones d'activité ayant détecté un événement de mouvement.

Nécessite Nest Aware. Lorsqu'il est utilisé avec le tableau activity_zones, vous pouvez récupérer le nom de la zone à partir de ces ID.

Si last_event/has_motion est

  • true = renvoie les ID de zone d'activité qui ont détecté un événement de mouvement
  • false = renvoie un tableau vide
Détails
https://developer-api.nest.com/devices/cameras/device_id/last_event/activity_zone_ids
Renvoiearray
Exemple: [ string1, string2,... ]
Accèslecture seule
Disponible enAppareil photo + lecture / images / v3-v4
Lecture/Écriture + images / v3-v4