API de câmera

A API Nest funciona com todos os modelos Nest Cam ™.

Os usuários podem adicionar várias Nest Cams ao grupo de devices/cameras , até o máximo por estrutura . Ao fazer uma chamada para esse local de dados, você pode acessar os dados da Nest Cam (valores de dados para dispositivos na estrutura).

Todos os valores abaixo são encontrados em cada devices/cameras/ device_id no documento JSON.

device_id

Identificador exclusivo da Nest Cam.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /device_id
Devoluções	string Exemplo: "awJo6rH ..."
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

software_version

Versão do software.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /software_version
Devoluções	string Exemplo: "4.0"
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

structure_id

Identificador exclusivo da estrutura.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /structure_id
Devoluções	string Exemplo: "VqFabWH21nw ..."
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação da câmera + imagens / v1-v4

where_id

Um identificador exclusivo gerado pelo Nest que representa o name , o nome de exibição do dispositivo.

Saiba mais sobre os nomes dos termostatosNest ,Nest Protects e Nest Cams .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /where_id
Devoluções	string Exemplo: "d6reb_OZTM ..."
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

where_name

O nome de exibição do dispositivo. Associado à Nest Cam where_id . Pode ser qualquer nome de sala de uma lista que fornecemos ou um nome personalizado. Saiba mais sobre os nomes dos termostatosNest ,Nest Protects e Nest Cams .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /where_name
Devoluções	string Exemplo: "Corredor"
Acesso	somente leitura
Disponível em	Leitura da câmera / v3 Leitura da câmera + imagens / v4 Leitura / gravação da câmera / v3 Leitura / gravação da câmera + imagens / v4

nome

Exibir nome do dispositivo; pode ser qualquer nome de sala de uma lista que fornecemos ou um nome personalizado.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /name
Devoluções	string Exemplo: "Corredor"
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação da câmera + imagens / v1-v4

name_long

Nome de exibição longo do dispositivo. Inclui um personalizado (rótulo), criado pelo usuário ou por meio de wheres .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /name_long
Devoluções	string Exemplo: "Câmera Nest de Corredor (andar de cima)"
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação da câmera + imagens / v1-v4

is_online

Status de conexão do dispositivo com o serviço Nest.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /is_online
Devoluções	boolean Valores: verdadeiro, falso
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

is_streaming

Status da câmera, seja ligada e ativamente transmitindo vídeo ou desligada. Consulte Como sua câmera funciona com o Assistente dentro / fora de casa para obter mais informações.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /is_streaming
Devoluções	boolean Valores: verdadeiro, falso
Acesso	ler / escrever
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

is_audio_input_enabled

Status do microfone da câmera, ligado e ouvindo ou desligado. Saiba mais sobre as configurações de áudio da Nest Cam .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /is_audio_input_enabled
Devoluções	boolean Valores: verdadeiro, falso
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

last_is_online_change

Timestamp que identifica a última mudança no status online, no formato ISO 8601 .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_is_online_change
Devoluções	string Exemplo: "2016-12-29T18: 42: 00.000Z"
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação da câmera + imagens / v1-v4

is_video_history_enabled

Status da assinatura do Nest Aware (assinatura ativa ou não).

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /is_video_history_enabled
Devoluções	boolean Valores: verdadeiro, falso
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação da câmera + imagens / v1-v4

web_url

URL da Web (link direto) para a transmissão de vídeo ao vivo em home.nest.com .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /web_url
Devoluções	string Exemplo: " https://home.nest.com/cameras/ device_id ?auth= camera_token "
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

app_url

URL do aplicativo (link direto) para a transmissão de vídeo ao vivo no aplicativo Nest.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /app_url
Devoluções	string Exemplo: " nestmobile://cameras/ device_id ?auth= camera_token "
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

is_public_share_enabled

Os usuários podem escolher compartilhar seu vídeo e torná-lo visível para qualquer pessoa. Quando o compartilhamento público está habilitado, você pode ler public_share_url .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /is_public_share_enabled
Devoluções	boolean Valores: verdadeiro, falso
Acesso	somente leitura
Disponível em	Leitura da câmera + imagens / v3-v4 Leitura / gravação da câmera + imagens / v3-v4

activity_zones

Retorna uma matriz de todas as zonas de atividade definidas.

As Zonas de atividade são usadas para monitorar eventos de movimento dentro de áreas definidas pelo usuário do fluxo de vídeo. Requer o Nest Aware .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /activity_zones
Devoluções	array Exemplo: [ {"name" : " string1 ", "id" : " string2 "},... ] • string1 é o nome da zona, definido pelo usuário ou gerado automaticamente quando a zona é criada. • string2 é um identificador atribuído pelo Nest quando a zona de atividade é criada.
Acesso	somente leitura
Disponível em	Leitura da câmera + imagens / v3-v4 Leitura / gravação da câmera + imagens / v3-v4

public_share_url

Você pode acessar este URL quando um usuário tornar seu stream de vídeo público .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /public_share_url
Devoluções	string Exemplo: " https://video.nest.com/live/ string1 ? string2 " string1 é o nome do stream de vídeo, definido pelo usuário ou gerado automaticamente quando o stream é definido como público.
Acesso	somente leitura
Disponível em	Leitura da câmera + imagens / v3-v4 Leitura / gravação de câmera + imagens / v3-v4

snapshot_url

Capture uma imagem sob demanda. Retorna o URL de uma imagem capturada do stream de vídeo ao vivo. Requer que a câmera esteja ligada e transmitindo ativamente.

Use este campo para obter um instantâneo da transmissão de vídeo ao vivo.

• snapshot_url - retorna o URL de uma imagem capturada do stream de vídeo ao vivo
• Requer que a câmera esteja ligada e transmitindo ativamente

A qualidade do instantâneo da API é apenas uma taxa de transferência de 1080p se você:

• visualizar ativamente o stream da câmera no aplicativo ( web_url )
• visualizar ativamente o stream público ( app_url )
• assinou Nest Aware

Se você não estiver visualizando o stream ativamente ou não tiver uma assinatura do Nest Aware, a API não tem uma fonte 1080p para recuperar um instantâneo nessa resolução e gera uma imagem de qualidade inferior. Além disso, a baixa largura de banda da rede local pode fazer com que a resolução do instantâneo da API caia abaixo de 1080p com o Nest Aware presente.

Saiba mais sobre os requisitos de largura de banda para câmeras Nest .

Limites de taxas se aplicam a esta chamada, dependendo do status da assinatura do Nest Aware.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /snapshot_url
Devoluções	string Exemplo: " string1 / device_id / string2 ?auth= camera_token "
Acesso	somente leitura
Disponível em	Leitura da câmera + imagens / v3-v4 Leitura / gravação da câmera + imagens / v3-v4

last_event

Este objeto captura informações sobre o último evento que acionou uma notificação.

Alguns campos e algumas combinações de permissão exigem uma assinatura do Nest Aware para acessar as informações do último evento.

Todos os valores abaixo são encontrados em cada devices/cameras/ device_id /last_event no documento JSON.

has_sound

Evento de som - foi detectado som.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_sound
Devoluções	boolean Valores: verdadeiro, falso
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

has_motion

Evento de movimento - movimento foi detectado.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_motion
Devoluções	boolean Valores: verdadeiro, falso
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação da câmera + imagens / v1-v4

has_person

Evento de pessoa - uma pessoa foi detectada.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_person
Devoluções	boolean Valores: verdadeiro, falso
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

start_time

Horário de início do evento, no formato ISO 8601 .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/start_time
Devoluções	string Exemplo: "2016-12-29T00: 00: 00.000Z"
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

end_time

Horário de término do evento, no formato ISO 8601 .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/end_time
Devoluções	string Exemplo: "2016-12-29T00: 00: 00.000Z"
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

urls_expire_time

Timestamp, no formato ISO 8601 , que identifica a expiração desses URLs relacionados ao evento:

• last_event/web_url
• last_event/app_url
• last_event/image_url
• last_event/animated_image_url

O tempo de expiração é calculado como: last_event/start_time + n dias (onde n = 10 ou 30 dias, dependendo do plano de assinatura do Nest Aware).

Requer o Nest Aware .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/urls_expire_time
Devoluções	string Exemplo: "2016-12-29T00: 00: 00.000Z"
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

web_url

URL da Web (link direto ) para o último evento de som ou movimento em home.nest.com . Usado para exibir o último evento registrado e requer que o usuário faça login na conta.

Requer o Nest Aware . Se a URL do evento tiver expirado ou o dispositivo não tiver uma assinatura ativa, esse valor não será incluído na carga útil.

Consulte last_event/urls_expire_time para obter informações sobre o tempo de expiração deste URL.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/web_url
Devoluções	string Exemplo: " https://home.nest.com/cameras/ device_id /cuepoints/ string ?auth= camera_token "
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação da câmera + imagens / v1-v4

app_url

URL do aplicativo Nest (link direto) para o último evento de som ou movimento. Usado para exibir o último evento registrado e requer que o usuário faça login na conta.

Requer o Nest Aware . Se o URL do evento tiver expirado ou o dispositivo não tiver uma assinatura ativa, esse valor não será incluído na carga útil.

Consulte last_event/urls_expire_time para obter informações sobre o tempo de expiração deste URL.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/app_url
Devoluções	string Exemplo: " nestmobile://cameras/ device_id /cuepoints/ string ?auth= camera_token "
Acesso	somente leitura
Disponível em	Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4

image_url

URL (link) para o arquivo de imagem capturado para um evento de som ou movimento.

Requer o Nest Aware . Consulte last_event/urls_expire_time para obter informações sobre o tempo de expiração deste URL.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/image_url
Devoluções	string Exemplo: " https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token "
Acesso	somente leitura
Disponível em	Leitura da câmera + imagens / v1-v4 Leitura / gravação + imagens da câmera / v1-v4

animated_image_url

URL (link) para o arquivo gif capturado para um evento de som ou movimento.

Requer o Nest Aware .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/animated_image_url
Devoluções	string Exemplo: " https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token "
Acesso	somente leitura
Disponível em	Leitura da câmera + imagens / v1-v4 Leitura / gravação + imagens da câmera / v1-v4

activity_zone_ids

Identificadores para zonas de atividade que detectaram um evento de movimento.

Requer o Nest Aware . Quando usado com a matriz activity_zones , você pode obter o nome da zona a partir desses ids.

Se last_event/has_motion for

• true = retorna os ids da zona de atividade que detectaram um evento de movimento
• false = retorna um array vazio

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/activity_zone_ids
Devoluções	array Exemplo: [ string1 , string2 ,... ]
Acesso	somente leitura
Disponível em	Leitura da câmera + imagens / v3-v4 Leitura / gravação de câmera + imagens / v3-v4