Camera API

摄像头设备与云事件 API 技能。用于查询设备列表、根据设备名解析 device_id、查询设备最新封面图、查询设备在线状态、按天查询或汇总云事件、查询单个事件详情,以及在需要最新画面时向设备发送截图指令并轮询结果。当用户要求查看某个摄像头当前画面、最新封面、在线状态、今天/昨天/某天/最近几天发生了什么、某个事...

安装

概览

Camera API 是一个专为智能摄像头设备设计的云端接口服务,旨在通过标准化的 RESTful API 实现设备管理、状态监控与事件查询等核心功能。该 API 支持用户快速获取设备列表、解析设备 ID、查看设备在线状态以及检索云存储的事件记录。无论是想了解某个摄像头当前是否在线、最近拍摄了哪些画面,还是希望回顾某一天内发生的异常活动,Camera API 都能提供结构化的响应结果,并以用户友好的方式呈现关键信息。

该服务特别注重隐私保护与数据安全性,所有请求均需通过 HTTPS 协议加密传输,并依赖 OAuth2 风格的 Bearer Token(TIVS_API_KEY)和 AppID(TIVS_APP_ID)进行身份验证。API 返回的图片 URL 通常带有临时签名参数,因此不会直接暴露原始链接给用户,而是优先下载图片内容后展示,避免因权限问题导致访问失败。此外,API 对接口路径与方法有严格限制,例如截图指令必须使用 POST /v2/msg/directive/device/{device_id},而查询抓拍结果则限定为 GET /v2/cloud/screenshot/{device_id},防止误用无效端点。

Camera API 的设计逻辑强调任务路由的合理性:当用户询问“今天发生了什么”时,系统会自动调用按天事件接口;若要求实时画面,则会先发送截图指令再轮询结果;对于模糊的设备名称,系统会借助设备列表接口完成精确匹配。整个流程兼顾效率与准确性,确保即使在多设备、多标签、分页查询等复杂场景下也能稳定运行。同时,API 对相对时间(如“昨天”“最近三天”)具备自动转换能力,统一处理为 YYYY-MM-DD 格式,提升用户体验的一致性。

核心功能特点

  1. 支持通过设备名称或备注名精准定位 device_id,自动分页遍历设备列表直至唯一匹配
  2. 提供设备在线状态综合判断,包括整体在线、注册连接、休眠存活及 RTC 连接等多维度状态分析
  3. 可按天查询云事件并支持按标签过滤,自动汇总事件摘要与图片信息,便于快速掌握每日动态
  4. 实现截图指令下发与结果轮询机制,优先调用专用抓拍接口,必要时回退至当天事件列表获取最新画面
  5. 严格遵循认证规范与安全策略,仅使用环境变量注入 TIVS_API_KEY 和 TIVS_APP_ID,禁止硬编码敏感信息
  6. 针对图片 URL 带签名的特性,优先下载内容而非返回原始链接,保障隐私并提高可用性

适用场景

Camera API 最适用于家庭安防、远程监护和企业级监控系统中对摄像头设备的集中管理与事件回溯需求。例如,当用户出差在外,可通过该 API 随时确认家中门铃摄像头是否在线、查看昨晚是否有陌生人触发警报,并调取相关截图作为证据。对于物业管理人员而言,可批量查询小区内多个出入口摄像头的运行状态,统计某段时间内的异常事件分布,辅助安保决策。在智能家居场景中,用户常需快速了解客厅摄像头当前画面是否正常,此时 API 会先发送截图指令,再轮询获取最新抓拍结果并展示图片,无需等待视频流加载。

另一个典型应用场景是运维排查。当某台设备频繁掉线或无法上传事件时,管理员可利用在线状态接口深入分析 register_status、dormant_status 和 rtc_status 等子系统状态,判断是网络中断、设备休眠还是 RTC 通道故障所致。若遇到设备命名混乱或多品牌共存的情况(如 icam365 和 wosee APP),API 能根据用户当前使用的 APP 名称动态引导其前往正确的 API Key 获取页面,避免凭证配置错误。此外,对于需要长期归档监控数据的机构,可通过按天事件接口定期拉取历史记录,结合 tag 字段筛选移动侦测、人脸识别等特定类型事件,生成结构化报告供后续审计使用。

值得注意的是,本技能仅适用于接入探鸽云平台的设备,局域网直连或本地部署的摄像头不受支持。若用户尝试查询未绑定到云端账户的设备,系统将明确提示不适用此类接口。同样,当截图指令发出后长时间无新事件上报,应告知用户设备可能处于离线或休眠状态,而非无限重试造成资源浪费。总体而言,Camera API 以轻量化、高可靠性和强兼容性为核心设计理念,覆盖从基础状态查询到高级事件分析的完整工作流,成为连接用户与智能摄像头生态的关键桥梁。