九、功能接口章节--视频录像管理接口讲解

h、视频录像

1)、选择通道开始视频录像指令

接口功能 本接口主要实现通过httpAPI接口选择摄像头设备，向流媒体服务器下达开始视频录像的指令。

Request URL: http://192.168.0.105:18080/api/record/startRecord
域名访问URL： http://iotbox.iotrelay.cn:8080/api/api/record/startRecord

Request Method: POST

数据提交格式  application/json

请求头参数  Authorization

请求头参数说明：

请求体格式 Content-Type

{
   "sipId": "44080000001111000001",
   "channelSn": "44090000001321000002"
}

请求体参数说明：

正确响应结果示例：

{
  "code": "0",
  "msg": "success",
  "data": "true",
}

错误响应结果示例：

{
  "code": "-1",
  "msg": "fail:录像执行失败"
}

2)、选择通道停止视频录像指令

接口功能 本接口主要实现通过httpAPI接口选择摄像头设备，向流媒体服务器下达停止视频录像的指令。

Request URL: http://192.168.0.105:18080/api/record/stopRecord
域名访问URL： http://iotbox.iotrelay.cn:8080/api/api/record/stopRecord

Request Method: POST

数据提交格式  application/json

请求头参数  Authorization

请求头参数说明：

请求体格式 Content-Type

{
   "sipId": "44080000001111000001",
   "channelSn": "44090000001321000002"
}

请求体参数说明：

正确响应结果示例：

{
  "code": "0",
  "msg": "success",
  "data": "true",
}

错误响应结果示例：

{
  "code": "-1",
  "msg": "fail:录像停止执行失败"
}

3)、查询通道视频是否正在录制中接口

接口功能 本接口主要提供httpAPI接口查询通道视频是否正在录制中。

Request URL: http://192.168.0.105:18080/api/record/queryIsRecording
域名访问URL： http://iotbox.iotrelay.cn:8080/api/api/record/queryIsRecording

Request Method: GET

数据提交格式  Query String Parameters

请求头参数  Authorization

请求头参数说明：

请求体参数说明：

正确响应结果示例：

{
  "code": "0",
  "msg": "查询流媒体视频是否正在录制中,true 为正在录制，false 为没有录制",
  "data": "true",
}

错误响应结果示例：

{
  "code": "-1",
  "msg": "fail:数据查询失败"
}

4)、获取通道对应的录像文件列表

接口功能 本接口主要提供httpAPI接口查询获取通道对应的录像文件列表。

Request URL: http://192.168.0.105:18080/api/record/queryRecordMp4File
域名访问URL： http://iotbox.iotrelay.cn:8080/api/api/record/queryRecordMp4File

Request Method:GET

数据提交格式 Query String Parameters

请求头参数  Authorization

请求头参数说明：

请求体参数说明：

正确响应结果示例：

{
  "code": "0",
  "msg": "共查询到2个录像文件",
  "data": [
           {
              "deviceId": "44090000001111000001",
              "channelId": "44090000001321000002",
              "fileName": "11-40-16.mp4",
              "filePath": "http://192.168.0.139:8010/recordPath/record/rtp/44090000001111000001_44090000001321000002/2023-10-08/11-40-16.mp4",
              "recordDate": "2023-10-08",
              "duration": "35",
              "bitRate": "2026000",
              "frameRaten": "25.0",
              "decoder": "h264 (Main) (avc1 / 0x31637661)",
           },
           {
              "deviceId": "44090000001111000001",
              "channelId": "44090000001321000002",
              "fileName": "11-41-54.mp4",
              "filePath": "http://192.168.0.139:8010/recordPath/record/rtp/44090000001111000001_44090000001321000002/2023-10-08/11-41-54.mp4",
              "recordDate": "2023-10-08",
              "duration": "37",
              "bitRate": "2035000",
              "frameRaten": "25.0",
              "decoder": "h264 (Main) (avc1 / 0x31637661)",
           },
            。。。。。。
]
}

响应体参数说明：

错误响应结果示例：

{
  "code": "-1",
  "msg": "fail:数据查询失败"
}

5)、查询iot流媒体服务器录像计划列表接口

接口功能 本接口主要实现通过httpAPI接口查询iot流媒体服务器录像计划列表。

Request URL: http://192.168.0.105:18080/api/record/queryZLMRecordPlanList
域名访问URL： http://iotbox.iotrelay.cn:8080/api/api/record/queryZLMRecordPlanList

Request Method: GET

数据提交格式  Query String Parameters

请求头参数  Authorization

请求头参数说明：

请求体参数说明：

正确响应结果示例：

{
  "code": "0",
  "msg": "success",
  "data": [
           {
              "id": "1719706668054454274",
              "channelName": "cameria_01",
              "sipId": "44090000001111000001",
              "channelSn": "44090000001321000002",
              "startTime": "2023-11-01 21:22:50",
              "stopTime": "2023-11-01 22:22:54",
              "isDeleted": "0",
              "isExecuted": "1",
              "startExecuteTime": "2023-11-01T21:51:22.920",
              "stopExecuteTime": "null",
              "remark": "null",
           },
           {
              "id": "1719706668054454275",
              "channelName": "cameria_03",
              "sipId": "44090000001111000001",
              "channelSn": "44090000001321000003",
              "startTime": "2023-11-01 21:22:50",
              "stopTime": "2023-11-01 22:22:54",
              "isDeleted": "0",
              "isExecuted": "1",
              "startExecuteTime": "2023-11-01T21:51:22.920",
              "stopExecuteTime": "null",
              "remark": "null",
           },
            。。。。。。
]
}

响应体参数说明：

错误响应结果示例：

{
  "code": "-1",
  "msg": "fail:录像计划数据查询失败"
}

6)、设置iot流媒体服务器录像计划接口

接口功能 本接口主要实现通过httpAPI接口选择摄像头设备，根据不同时间段添加录像计划。 注：每个摄像头通道可以添加多个录像执行计划，录像执行计划时间段不能重复，录像时间段时长不要设置太长，避免生成的录像数据占用大量磁盘空间。

Request URL: http://192.168.0.105:18080/api/record/setZLMRecordPlan
域名访问URL： http://iotbox.iotrelay.cn:8080/api/api/record/setZLMRecordPlan

Request Method: POST

数据提交格式  application/json

请求头参数 Authorization

请求头参数说明：

请求体格式 Content-Type

{
  "deviceId": "44080000001111000001",
  "channelId": "44090000001321000002"
  "recordPlanList": [
       {
          "startTime": "2023-11-04 10:38:00",
          "stopTime": "2023-11-04 10:45:00"
       },
       {
          "startTime": "2023-11-05 20:00:00",
          "stopTime": "2023-11-05 20:30:00"
       },
            。。。。。。
  ]
 }

请求体参数说明：

正确响应结果示例：

{
  "code": "0",
  "msg": "保存录像计划成功",
  "data": "true",
}

错误响应结果示例：

{
  "code": "-1",
  "msg": "fail:保存录像计划失败"
}

7)、删除取消iot流媒体服务器录像计划接口

接口功能 本接口主要实现通过httpAPI接口实现删除取消iot流媒体服务器录像计划。

Request URL: http://192.168.0.105:18080/api/record/cancelZLMRecordPlan
域名访问URL： http://iotbox.iotrelay.cn:8080/api/api/record/cancelZLMRecordPlan

Request Method: POST

数据提交格式  application/json

请求头参数  Authorization

请求头参数说明：

请求体格式 form-data

请求体参数说明：

正确响应结果示例：

{
  "code": "0",
  "msg": "success",
  "data": "true",
}

错误响应结果示例：

{
  "code": "-1",
  "msg": "fail:操作失败"
}

8)、下载录像文件

接口功能 本iot视频平台录像文件路径由《 4)、获取通道对应的录像文件列表》章节接口查询获取。

例如获取到的视频录像文件地址: http://192.168.0.105:8010/recordPath/record/rtp/44090000001111000001_44090000001321000002/2023-10-08/11-41-54.mp4
特别说明： 如果您IOT中继宝盒申请了子域名启用了内网穿透功能，既外网调用接口，对照获取的内网录像文件地址，则外网视频录像文件地址为: http://video.iotbox.iotrelay.cn:8080/recordPath/record/rtp/44090000001111000001_44090000001321000002/2023-10-08/11-41-54.mp4

可以通过程序io流下载，也可以在本IOT中继平台–视频管理–通道–录像查询—选择录像文件下载。