开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
    • 按设备类型浏览
    • 设备能力
      • 通用方法
      • 侦测与告警
      • 图像
      • 云台
      • 灯光
      • 录像
        • 普通事件投递
        • 本地录像
          • record.file.cover(获取SD卡录像封面图属性)
          • record.file.pageSize(获取本地录像每页文件数属性)
          • record.file.download(获取局域网下载属性)
          • record.file.list(获取本地录像)
          • record.file.alarmList(获取本地录像(根据消息时间))
          • record.file.count(获取本地录像总数)
          • record.file.bitmap(获取本地录像掩码)
        • 计划
        • 回放
        • 延时
      • 音频
      • 媒体
      • 网络
      • 电源
      • 隐私
      • 呼叫
      • 存储
      • 系统
      • 算法
      • 设备维护
      • 控制
    • 事件总览
    • 权限码
    • 错误码
    • 告警与能力消息
    • 常见问题
    • 历史能力与推送类型
  • API 参考
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能详情
请求地址
最小权限
传入参数说明
样例输入
返回 data 字段说明
样例输出
错误码

record.file.list(获取本地录像)

record.file.list:获取本地录像

record.file.list · 通道级 · 权限 RecordReplay

功能详情

本地录像:按时间拉取本路本地录像文件列表(非播放器播控)。入参 beginTime、endTime、type、limit(30~100)。sessionId 非必填;若上轮响应返回 sessionId,下次请求可带上以优化查询,不作为分页依据——分页请用 beginTime、endTime 与 limit 滑动时间窗口。返回 records 最多 100 条。勿与遗留 queryLocalRecords 的 count/queryRange 混用。调一次执行一次。type 枚举以 本页表 为准(含 17 vlog、21 localRecord);count 与 bitmap 的允许取值 并不完全相同(例如 count 无 21、bitmap 无 17)。以 device.capability.list 与各叶说明为准。

路由:对外统一 v2 device.service.invoke;部分设备由平台映射至设备侧 Open-OPS(如 record/list),开放平台不会再代调 queryLocalRecords。能力清单中列出本服务的设备走 invoke。回放见 SDK/播放器文档。

请求地址

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.service.invoke

最小权限

管理员操作自己绑定的设备不需要权限。操作被分享设备需要本地录像查看权限。子用户绑定不需要。子账号需要 RecordReplay。通道级漏 channelId 返回 DV2007。设备和通道写在同一次请求里返回 DV2008。超时不代表未执行。

传入参数说明

参数名参数类型是否必填参数说明
tokenString是管理员、子用户或子账号 accessToken
deviceIdString是设备序列号
productIdString否可省略。传了且与该设备实际型号不一致 → DV2009
channelIdString是通道号,IPC 常见 "0"
serviceIdString是record.file.list
inputDataObject是见下表
参数名说明类型必填取值
type类型。enum是0 all;1 normal;2 videomotion;3 human;4 faceDetect;5 faceRecognition;6 crossLine;7 crossRegion;8 leftDetection;9 takenAwayDetection;10 abAlarmSound;11 callEvent;12 muti;13 smdTypeHuman;14 smdTypeVehicle;15 smdTypeHumanAndVehicle;17 vlog;18 packageOnDuty;19 aor(aov+音频);20 aov;21 localRecord
beginTime开始时间。墙钟时间,格式 YYYY-MM-DD HH:mm:ss。text是格式 YYYY-MM-DD HH:mm:ss
endTime结束时间。墙钟时间,格式 YYYY-MM-DD HH:mm:ss。text是格式 YYYY-MM-DD HH:mm:ss
sessionId会话 ID。用于查询优化;非分页依据。text否字符串;可传上轮响应中的 sessionId
limit条数。范围 30~100,步长 1。int是30~100,步长 1

公共请求字段与签名见 签名约定 与 公共请求负载。

样例输入

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345",
 "channelId": "0",
 "serviceId": "record.file.list",
 "inputData": {
 "type": "0",
 "beginTime": "2026-09-19 00:00:00",
 "endTime": "2026-09-19 23:59:59",
 "limit": 30
 }
 }
}

返回 data 字段说明

出参在 result.data.outputData。

参数名说明类型必填取值
sessionId会话 ID。下次请求可带回以优化查询。text否字符串
records录像列表。最多 100 条。array否最多 100 条
records.item.fileName文件名。text否字符串
records.item.fileLength文件长度。范围 0~999999,步长 1,单位 byte。int否0~999999,步长 1,单位 byte
records.item.type类型。enum否0 all;1 normal;2 videomotion;3 human;4 faceDetect;5 faceRecognition;6 crossLine;7 crossRegion;8 leftDetection;9 takenAwayDetection;10 abAlarmSound;11 callEvent;12 muti;13 smdTypeHuman;14 smdTypeVehicle;15 smdTypeHumanAndVehicle;17 vlog;18 packageOnDuty;19 aor(aov+音频);20 aov;21 localRecord
records.item.streamType码流类型。enum否0 主码流;1 辅码流1;2 辅码流2;3 辅码流3
records.item.beginTime开始时间。墙钟时间,格式 YYYY-MM-DD HH:mm:ss。text否格式 YYYY-MM-DD HH:mm:ss
records.item.endTime结束时间。墙钟时间,格式 YYYY-MM-DD HH:mm:ss。text否格式 YYYY-MM-DD HH:mm:ss
records.item.localBeginTime设备开始时间。墙钟时间,格式 YYYY-MM-DD HH:mm:ss。text否格式 YYYY-MM-DD HH:mm:ss
records.item.localEndTime设备结束时间。墙钟时间,格式 YYYY-MM-DD HH:mm:ss。text否格式 YYYY-MM-DD HH:mm:ss
records.item.objectType目标类型。text否字符串
records.item.xseq序号。范围 0~9999999,步长 1。int否0~9999999,步长 1
records.item.multiType复合类型。text否字符串
records.item.picId封面图 ID。范围 0~999999,步长 1。int否0~999999,步长 1

样例输出

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "outputData": {
 "sessionId": "s-1",
 "records": [
 {
 "fileName": "rec-1",
 "fileLength": 1024,
 "type": "1",
 "streamType": "0",
 "beginTime": "2026-09-19 08:00:00",
 "endTime": "2026-09-19 08:10:00",
 "localBeginTime": "2026-09-19 08:00:00",
 "localEndTime": "2026-09-19 08:10:00",
 "objectType": "",
 "xseq": 1,
 "multiType": "",
 "picId": 0
 }
 ]
 }
 }
 }
}

错误码

错误码错误码说明下一步
SN1001签名校验异常按 HTTP 开发规范 核对 sign
TK1002token 无效或过期重新获取 accessToken
OP1002缺少必填参数补必填字段
OP1003参数不合法按本页参数表核对
OP1009权限不足核对 token 与设备绑定/分享权限
OP1013接口总次数超限降低调用频率
OP1014接口日限额超限见 接口调用限额
DV1007设备离线等设备上线

更多见 错误码 · OP/SN/TK。

错误码错误码说明下一步
DV2003设备未声明该能力以 device.capability.list 为准
DV2007channelId 与 scope 不符通道级必传,设备级不传
DV2008同请求混用设备级与通道级拆分请求
DV2009productId 与型号不一致省略或改为实际型号
DV2011无能力权限见 权限码

更多见 能力错误码。

本地录像

record.file.download(获取局域网下载属性)
record.file.alarmList(获取本地录像(根据消息时间))