乐橙云开发文档
控制台
更新日志
控制台
更新日志
快速入门
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
  • API 参考
    • 公共约定
    • 账号与授权
    • 设备管理
    • 设备能力
    • 设备配置与操作
      • setPreparation(预案设置)
      • getPreparation(获取预案)
      • setHeatMapEnable(设置热度分析通道级使能开关)
      • getHeatMapEnable(获取热度分析通道级使能开关)
      • getHeatMapData(热度图数据获取)
      • setDeviceSnap(设备抓图)
      • setDeviceSnapEnhanced(设备抓图(升级版))
    • 直播地址
    • 录像查询
    • 告警记录
    • 推送配置
    • 门锁
    • 云存储
    • 云转存
    • AI分析
    • AI智见
    • 资源池额度管理
    • 遗留接口
  • SDK 与工具
  • 行业方案
  • 平台与支持
本页目录
请求参数
请求示例
响应字段
响应示例
错误码
说明
相关

setDeviceSnap(设备抓图)

setDeviceSnap:设备抓图

要点:https://openapi.lechange.cn/openapi/setDeviceSnap · 权限 Capture · Resource cam:{deviceId}:{channelId} · 见 错误码

设备抓图,支持抓图频率1次/3s。

客户端请求时间间隔需大于等于3s。

备注:

建议开发者根据设备性能实测接口后,来确定使用哪个设备抓图接口:

若设备性能较好(每秒都可以处理并返回抓图图片),则建议开发者调用setDeviceSnapEnhanced接口;

若设备性能较差(主要针对2017年前上市的设备),则建议开发者调用setDeviceSnap接口进行设备抓图。

请求参数

参数名参数类型是否必填默认值合法值参数说明
tokenString是管理员或者子账号accessToken
deviceIdString是设备序列号
channelIdString是通道号

请求示例

{
    "system":{
        "ver":"1.0",
        "appId":"lcdxxxxxxxxx",
        "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
        "time":1603369597,
        "nonce":"755263ee-7301-43c9-9d65-464f0febfc80"
    },
    "id":"c8dd3f09-554b-41dc-8616-76889952e24e",
    "params":{
        "deviceId":"TESTQWERXXXX",
        "channelId":"0",
        "token": "<yourAccessToken>"
    }
}

响应字段

字段名字段类型字段说明
urlString抓图访问地址

响应示例

{
    "result":{
        "msg":"操作成功。",
        "code":"0",
        "data":{
            "url":"https://lechangecloud.oss-cn-hangzhou.aliyuncs.com/lechange/TESTQWERXXXX_img/Alarm/0/7aa3f5dd3bf1436a87ca1828aad382c3.jpg?issued-by-platform=true"
        }
    },
    "id":"c8dd3f09-554b-41dc-8616-76889952e24e"
}

错误码

本接口可能返回下列码;完整分组见 错误码。

网关与鉴权(SN / TK / OP)

错误码错误码说明下一步
SN1001签名异常按 签名 核对 sign
TK1002token 无效或过期重新获取 token
OP1002缺少必填参数补必填字段
OP1003参数不合法按本页参数表核对
OP1039分钟级限流等到下一分钟再试
OP1040调用超限降低频率
DV1007设备离线或超时等设备上线

子账号(SUB)

错误码错误码说明下一步
SUB1001子账号无指定权限在 子账号策略 中补权限
SUB1002子账号无任何设备权限授权设备或调整策略
SUB1005子账号 token 过期重新 获取子账号 token
SUB1006子账号与设备无授权关系核对 Resource 与设备序列号
SUB1008子账号未绑定当前应用先创建并绑定子账号
SUB1007创建子账号失败核对参数后重试
SUB1009子账号创建失败,账号格式错误account 须为手机号或邮箱
SUB1010子账号创建失败,账号已存在勿重复绑定同一子账号到应用

更多见 错误码 · SUB。

设备访问与通道(DV10xx)

错误码错误码说明下一步
DV1007设备离线或超时等设备上线;低电休眠先 唤醒
DV1009设备正忙稍后重试
DV1012分享/授权设备权限不足核对子账号 Permission / Resource
DV1019能力集不支持确认型号与 设备能力
DV1020通道离线检查通道与设备状态
DV1026不支持此功能换接口或升级固件
DV1028未绑定或通道不存在核对 deviceId / channelId
DV1030设备休眠唤醒后再调
DV1057通道不存在核对通道号
DV1061设备响应超时检查设备网络
DV1062需先唤醒设备调用唤醒接口
DV1069不满足操作条件见 msg

抓图(DV10xx)

错误码错误码说明下一步
DV1010抓图过于频繁降低调用频率
DV1053抓图失败检查网络与设备在线

说明

子账号 token 须具备最小权限:Permission 为 Capture,Resource 为 cam:{deviceId}:{channelId}。配置见 权限码。

相关

  • 设备配置与操作

商务合作:cloud_openteam@imou.com · 工单 · 获取帮助(公众号、小程序试用中心)

Copyright © 2015-2026 IMOU. All Rights Reserved. 浙ICP备16023676号

getHeatMapData(热度图数据获取)
setDeviceSnapEnhanced(设备抓图(升级版))