指令目录
- 1. queryLocalRecordingIntervel
- 2 .buildTunnel
- 3. getChannelsCapabilities
- 4. upgradeChannelFirmware
- 5. checkChannelUpgradeStatus
- 6. setLastWill
- 7. startEventDownloadwithURL
- 8. getLiveCapabilitiesEx
- 9. startLiveStreamEx
- 10. answerDoorBell
- 11. getGeoLocation
- 12. startWebRtcEx
- 13. triggerCloudRecording
- 14. triggerLocalRecording
- 15. reboot
- 16. zoomStep
- 17. stopLiveStreamEx
- 18. setPTZPreset
- 19. gotoPTZPreset
- 20. deletePTZPreset
- 21. startPTZPatrol
- 22. stopPTZPatrol
- 23. setLightMode
- 24. getLightStatus
- 25. setAudioVolume
- 26. getAudioVolume
- 27. enableTwoWayAudio
- 28. disableTwoWayAudio
- 29. setMotionDetection
- 30. getMotionDetection
- 31. setHumanDetection
- 32. getHumanDetection
- 33. setVideoQuality
- 34. getVideoQuality
- 35. enableMotionAlarm
- 36. disableMotionAlarm
- 37. enableHumanAlarm
- 38. disableHumanAlarm
- 39. startRecord
- 40. stopRecord
- 41. getRecordStatus
- 42. setRecordSchedule
- 43. getRecordSchedule
- 44. enableSoundAlarm
- 45. disableSoundAlarm
- 46. setAlarmSensitivity
- 47. getAlarmSensitivity
- 48. enableIRCut
- 49. disableIRCut
- 50. getIRCutStatus
- 51. setVideoRotation
- 52. getVideoRotation
- 53. enableSDCardFormat
- 54. getSDCardStatus
- 55. setSDCardLoopRecord
- 56. getSDCardLoopRecord
- 57. enableCloudRecord
- 58. disableCloudRecord
- 59. getCloudRecordStatus
- 60. setAlarmNotification
- 61. getAlarmNotification
- 62. enablePTZControl
- 63. setPTZDirection
- 64. getPTZStatus
核心接口说明
queryLocalRecordingIntervel
描述： 查询本地录像时间区间
版本： 1.1
指令集： playback
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| startTime | Int | M | 开始时间戳（UNIX时间） |
| endTime | Int | M | 结束时间戳（UNIX时间） |
| channel | Int | O | 通道ID |
返回值： 200, 400
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| results | interval object array | M | 时间区间对象数组（每个区间为两个Int型UNIX时间戳组成的数组） |
An interval object is an array that contains two “Int” to represent an interval of time by UNIX timestamp.
Profile定义：
{
"func":"queryLocalRecordingIntervel",
"args":{
"startTime":"Int",
"endTime":"Int",
"channels":"Array"
},
"return":{
"results":[["Int"]]
}
}
Nebula指令请求例子：
{
"func":"queryLocalRecordingIntervel",
"args":{
"startTime":1512121200,
"endTime":1515121200,
"channels":[1,2]
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"results":[[1512121200,1512131200],[1512141200,1512151200]]
}
}
buildTunnel
描述： 构建隧道连接
版本： 1.1
指令集： tunnel
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| protocol | String | M | 隧道协议类型 |
返回值： 200, 400
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| username | String | M | 隧道认证用户名 |
| password | String | M | 隧道认证密码 |
| iotc-channel | Int | M | IOTC通道ID |
Profile定义：
{
"func":"buildTunnel",
"args":{
"protocol":"String"
},
"return":{
"username":"String",
"password":"String",
"iotc-channel":"Int"
}
}
Nebula指令请求例子：
{
"func":"buildTunnel",
"args":{
"protocol":"iotc-tunnel"
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"username":"admin",
"password":"12345678",
"iotc-channel":1
}
}
getChannelsCapabilities
描述： 获取通道能力信息
版本： 1.1
指令集： channelInfo
请求参数： Empty
返回值： 200, 400
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channels | capability object array | M | 通道能力对象数组 |
Elements of a capability object
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| signal | String | M | 信号类型 |
| capabilities | String array | M | 能力列表 |
| hasBattery | Boolean | M | 是否有电池 |
| light | String array | O | 灯光能力 |
| ptz | String array | O | PTZ控制能力 |
| sensors | sensor object array | O | 传感器对象数组 |
Elements of a sensor object
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| sensor | String | M | 传感器类型 |
| modes | String array | O | 传感器模式 |
Please check setEventRecordingTriggers for the enumeration of triggers.
Profile定义：
{
"func":"getChannelsCapabilities",
"return":{
"channels":[
{
"channel":"Int",
"signal":"String",
"capabilities":["String"],
"light":["String"],
"ptz":["String"],
"sensors":[{
"sensor":"String",
"modes":["String"]
}
],
"hasBattery":"Boolean"
}
]
}
}
Nebula指令请求例子：
{
"func":"getChannelsCapabilities"
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content": {
"channels": [
{
"channel": 1,
"hasBattery": false,
"signal": "TVI",
"capabilities": [
"cloudRecording",
"mic",
"speaker",
"full_duplex",
"light",
"ptz",
"sensor",
"accelerometer"
],
"light": [
"autoDawnDusk"
],
"ptz": [
"pan",
"tilt",
"zoom",
"nodes",
"patrol"
],
"sensors": [
{
"sensor": "motion",
"modes": [
"motionSensor",
"pir"
]
},
{
"sensor": "objectDetection",
"modes": [
"human",
"vehicle",
"animal"
]
},
{
"sensor": "facialRecognition",
"modes": [
"familiar",
"unfamiliar"
]
},
{
"sensor": "other",
"modes": [
"doorbellRing",
"lowBattery"
]
},
{
"sensor": "soundDetection",
"modes": [
"babyCry",
"rareSound"
]
},
{
"sensor": "schedule"
}
]
},
{
"channel": 2,
"hasBattery": false,
"signal": "TVI",
"capabilities": [
"cloudRecording",
"speaker",
"full_duplex",
"ptz",
"sensor"
],
"ptz": [
"pan",
"tilt",
"zoom"
],
"sensors": [
{
"sensor": "motion",
"modes": [
"lineCrossing",
"pir"
]
}
]
}
]
}
}
upgradeChannelFirmware
描述： 升级通道固件
版本： 1.1
指令集： ota
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| url | String | M | 固件升级包URL |
| auto | Boolean | M | 自动升级标识 |
返回值： 200, 400
返回内容： Empty
Profile定义：
{
"func": "upgradeChannelFirmware",
"args": {
"channel": "Int",
"url": "String",
"auto": "Boolean"
}
}
Nebula指令请求例子：
{
"func": "upgradeChannelFirmware",
"args": {
"channel": 1,
"url": "https://kota.kalayservice.com/ota/GET/i/Company/Product/Model",
"auto": true
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
checkChannelUpgradeStatus
描述： 检查通道升级状态
版本： 1.1
指令集： ota
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| status | Int | M | 升级状态（参考checkFirmwareUpgradeStatus枚举值） |
Please check checkFirmwareUpgradeStatus for the enumeration of status
Profile定义：
{
"func": "checkChannelUpgradeStatus",
"args": {
"channel": "Int"
},
"return":{
"status":"Int"
}
}
Nebula指令请求例子：
{
"func": "checkChannelUpgradeStatus",
"args": {
"channel": 1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"status":1
}
}
setLastWill
描述： 设置遗嘱消息
版本： 1.1
指令集： serverNotification
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| url | String | M | 通知URL |
| header | Dictionary | O | 请求头信息 |
返回值： 200, 400
返回内容： Empty
Profile定义：
{
"func":"setLastWill",
"args":{
"url":"String",
"header": "Dictionary"
}
}
Nebula指令请求例子：
{
"func":"setLastWill",
"args":{
"url":"String",
"header": {
"headerData1":"242343432423"
}
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
startEventDownloadwithURL
描述： 通过URL启动事件下载
版本： 1.1
指令集： playback
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| startTime | Int | O | 时间戳（单位：秒），1.2版本改为可选 |
| channel | Int | O | 通道ID |
| fileName | String | O | 若设备仅能通过文件名生成下载URL则使用此字段 |
返回值： 200, 400
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| downloadUrl | String | M | 下载URL |
| filesize | Int | O | 文件大小（单位：字节） |
Profile定义：
{
"func":"startEventDownloadwithURL",
"args":{
"channel":"int",
"startTime":"Int"
},
"return":{
"downloadUrl":"String",
"filesize":"Int"
}
}
Nebula指令请求例子：
{
"func":"startEventDownloadwithURL",
"args":{
"channel":1,
"startTime":1567612800
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"downloadUrl":"http://iotc-tunnel:80/file/to/path",
"filesize":12000000
}
}
getLiveCapabilitiesEx
描述： 获取直播能力扩展信息
版本： 1.1
指令集： liveStreamingEx
请求参数： Empty
返回值： 200, 400
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| protocol | String array | M | 支持的协议列表 |
| channels | Array of channel object | M | 每个通道的能力信息 |
The elements of a channel object
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channelId | Int | O | 通道ID |
| streamType | String array | M | 流类型列表 |
Enumeration of protocol
- webrtc
- rtsp-iotc-tunnel
- iotc-av
Enumeration of streamType
- video
- audio
- subVideo
- audioAndVideo
- audioAndSubVideo
Profile定义：
{
"func":"getLiveCapabilitiesEx",
"return":{
"protocol":["String"],
"channels":[
{
"channelId":"Int",
"streamType":["String"]
}
]
}
}
Nebula指令请求例子：
{
"func":"getLiveCapabilitiesEx"
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"protocol":["rtsp-iotc-tunnel","iotc-av","webrtc"],
"channels":[
{
"channelId":0,
"streamType":["video","audioAndVideo"]
},
{
"channelId":1,
"streamType":["video","audioAndVideo"]
}
]
}
}
or the camera without channelId
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"protocol":["rtsp-iotc-tunnel","iotc-av","webrtc"],
"channels":[
{
"streamType":["video","audioAndVideo"]
}
]
}
}
startLiveStreamEx
描述： 启动直播流扩展
版本： 1.1
指令集： liveStreamingEx
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channels | Array of channel object | M | 通道对象数组 |
The elements of a channel object
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channelId | Int | O | 通道ID |
| streamType | String | M | 流类型（参考getLiveCapabilitiesEx枚举） |
| resolution | Object | O | 分辨率{width:Int, height:Int}，默认最高分辨率 |
| frameRate | Int | O | 帧率（fps），默认25 |
| bitrate | Int | O | 码率（kbps），默认2048 |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"startLiveStreamEx",
"args":{
"channels":[
{
"channelId":"Int",
"streamType":"String",
"resolution":{
"width":"Int",
"height":"Int"
},
"frameRate":"Int",
"bitrate":"Int"
}
]
}
}
Nebula指令请求例子：
{
"func":"startLiveStreamEx",
"args":{
"channels":[
{
"channelId":0,
"streamType":"video",
"resolution":{
"width":1920,
"height":1080
},
"frameRate":30,
"bitrate":4096
}
]
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getLiveStreamStatusEx
描述： 获取直播流状态扩展
版本： 1.1
指令集： liveStreamingEx
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| status | String | M | 流状态（running/stopped/error） |
| streamType | String | M | 当前流类型 |
| resolution | Object | M | 当前分辨率{width:Int, height:Int} |
| frameRate | Int | M | 当前帧率（fps） |
| bitrate | Int | M | 当前码率（kbps） |
| duration | Int | O | 流运行时长（秒），仅status=running时返回 |
Profile定义：
{
"func":"getLiveStreamStatusEx",
"args":{
"channel":"Int"
},
"return":{
"status":"String",
"streamType":"String",
"resolution":{
"width":"Int",
"height":"Int"
},
"frameRate":"Int",
"bitrate":"Int",
"duration":"Int"
}
}
Nebula指令请求例子：
{
"func":"getLiveStreamStatusEx",
"args":{
"channel":0
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"status":"running",
"streamType":"video",
"resolution":{
"width":1920,
"height":1080
},
"frameRate":30,
"bitrate":4096,
"duration":120
}
}
setPTZSpeed
描述： 设置PTZ云台移动速度
版本： 1.1
指令集： ptzControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| panSpeed | Int | M | 水平移动速度（1-10，1最慢，10最快） |
| tiltSpeed | Int | M | 垂直移动速度（1-10，1最慢，10最快） |
| zoomSpeed | Int | O | 变焦速度（1-10，默认5） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"setPTZSpeed",
"args":{
"channel":"Int",
"panSpeed":"Int",
"tiltSpeed":"Int",
"zoomSpeed":"Int"
}
}
Nebula指令请求例子：
{
"func":"setPTZSpeed",
"args":{
"channel":1,
"panSpeed":8,
"tiltSpeed":6,
"zoomSpeed":5
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
controlPTZ
描述： 控制PTZ云台移动
版本： 1.1
指令集： ptzControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| action | String | M | 操作类型（panLeft/panRight/tiltUp/tiltDown/zoomIn/zoomOut） |
| continuous | Boolean | O | 是否持续移动（true/false，默认false） |
| duration | Int | O | 移动时长（秒），仅continuous=false时生效，默认1 |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"controlPTZ",
"args":{
"channel":"Int",
"action":"String",
"continuous":"Boolean",
"duration":"Int"
}
}
Nebula指令请求例子：
{
"func":"controlPTZ",
"args":{
"channel":1,
"action":"panRight",
"continuous":false,
"duration":2
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
stopPTZ
描述： 停止PTZ云台移动
版本： 1.1
指令集： ptzControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| action | String | O | 停止的操作类型（pan/tilt/zoom/all，默认all） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"stopPTZ",
"args":{
"channel":"Int",
"action":"String"
}
}
Nebula指令请求例子：
{
"func":"stopPTZ",
"args":{
"channel":1,
"action":"all"
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getPTZPresetList
描述： 获取PTZ预置位列表
版本： 1.1
指令集： ptzControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| presets | Array of Object | M | 预置位列表 |
The elements of a preset object
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| presetId | Int | M | 预置位ID（1-255） |
| presetName | String | O | 预置位名称 |
| pan | Int | O | 水平角度（0-360） |
| tilt | Int | O | 垂直角度（0-90） |
| zoom | Int | O | 变焦倍数（1-10） |
Profile定义：
{
"func":"getPTZPresetList",
"args":{
"channel":"Int"
},
"return":{
"presets":[
{
"presetId":"Int",
"presetName":"String",
"pan":"Int",
"tilt":"Int",
"zoom":"Int"
}
]
}
}
Nebula指令请求例子：
{
"func":"getPTZPresetList",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"presets":[
{
"presetId":5,
"presetName":"FrontDoor",
"pan":90,
"tilt":45,
"zoom":3
},
{
"presetId":8,
"presetName":"BackYard",
"pan":270,
"tilt":30,
"zoom":5
}
]
}
}
getPTZPatrolList
描述： 获取PTZ巡航列表
版本： 1.1
指令集： ptzControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| patrols | Array of Object | M | 巡航列表 |
The elements of a patrol object
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| patrolId | Int | M | 巡航ID（1-16） |
| patrolName | String | O | 巡航名称 |
| presetIds | Array of Int | M | 巡航包含的预置位ID列表 |
| dwellTimes | Array of Int | O | 每个预置位停留时长（秒），与presetIds一一对应 |
| speed | Int | O | 巡航速度（1-10，默认5） |
Profile定义：
{
"func":"getPTZPatrolList",
"args":{
"channel":"Int"
},
"return":{
"patrols":[
{
"patrolId":"Int",
"patrolName":"String",
"presetIds":["Int"],
"dwellTimes":["Int"],
"speed":"Int"
}
]
}
}
Nebula指令请求例子：
{
"func":"getPTZPatrolList",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"patrols":[
{
"patrolId":1,
"patrolName":"MainArea",
"presetIds":[5,8,10],
"dwellTimes":[10,15,10],
"speed":6
},
{
"patrolId":2,
"patrolName":"SideArea",
"presetIds":[3,7],
"dwellTimes":[8,12],
"speed":5
}
]
}
}
stopLiveStreamEx
描述： 停止直播流扩展
版本： 1.1
指令集： liveStreamingEx
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channels | Array of channel object | M | 通道对象数组 |
The elements of a channel object
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channelId | Int | O | 通道ID |
| streamType | String | M | 流类型（参考getLiveCapabilitiesEx枚举） |
返回值： 200, 400
返回内容： Empty
Profile定义：
{
"func":"stopLiveStreamEx",
"args":{
"channels":[
{
"channelId":"Int",
"streamType":"String"
}
]
}
}
Nebula指令请求例子：
{
"func":"stopLiveStreamEx",
"args":{
"channels":[
{
"channelId":0,
"streamType":"video"
}
]
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
setPTZPreset
描述： 设置PTZ预置位
版本： 1.1
指令集： ptzControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| presetId | Int | M | 预置位ID（1-255） |
| presetName | String | O | 预置位名称 |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"setPTZPreset",
"args":{
"channel":"Int",
"presetId":"Int",
"presetName":"String"
}
}
Nebula指令请求例子：
{
"func":"setPTZPreset",
"args":{
"channel":1,
"presetId":5,
"presetName":"FrontDoor"
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
gotoPTZPreset
描述： 跳转至PTZ预置位
版本： 1.1
指令集： ptzControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| presetId | Int | M | 预置位ID（1-255） |
| speed | Int | O | 移动速度（1-10，默认5） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"gotoPTZPreset",
"args":{
"channel":"Int",
"presetId":"Int",
"speed":"Int"
}
}
Nebula指令请求例子：
{
"func":"gotoPTZPreset",
"args":{
"channel":1,
"presetId":5,
"speed":8
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
deletePTZPreset
描述： 删除PTZ预置位
版本： 1.1
指令集： ptzControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| presetId | Int | M | 预置位ID（1-255） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"deletePTZPreset",
"args":{
"channel":"Int",
"presetId":"Int"
}
}
Nebula指令请求例子：
{
"func":"deletePTZPreset",
"args":{
"channel":1,
"presetId":5
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
startPTZPatrol
描述： 启动PTZ巡航
版本： 1.1
指令集： ptzControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| patrolId | Int | M | 巡航ID（1-16） |
| speed | Int | O | 巡航速度（1-10，默认5） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"startPTZPatrol",
"args":{
"channel":"Int",
"patrolId":"Int",
"speed":"Int"
}
}
Nebula指令请求例子：
{
"func":"startPTZPatrol",
"args":{
"channel":1,
"patrolId":1,
"speed":6
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
stopPTZPatrol
描述： 停止PTZ巡航
版本： 1.1
指令集： ptzControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| patrolId | Int | M | 巡航ID（1-16） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"stopPTZPatrol",
"args":{
"channel":"Int",
"patrolId":"Int"
}
}
Nebula指令请求例子：
{
"func":"stopPTZPatrol",
"args":{
"channel":1,
"patrolId":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
setLightMode
描述： 设置灯光模式
版本： 1.1
指令集： deviceControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| mode | String | M | 灯光模式（auto/on/off/dawnDusk） |
| brightness | Int | O | 亮度（1-100，仅mode=on时生效） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"setLightMode",
"args":{
"channel":"Int",
"mode":"String",
"brightness":"Int"
}
}
Nebula指令请求例子：
{
"func":"setLightMode",
"args":{
"channel":1,
"mode":"on",
"brightness":80
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getLightStatus
描述： 获取灯光状态
版本： 1.1
指令集： deviceControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| mode | String | M | 当前灯光模式 |
| brightness | Int | O | 当前亮度（1-100） |
| status | String | M | 实际状态（on/off） |
Profile定义：
{
"func":"getLightStatus",
"args":{
"channel":"Int"
},
"return":{
"mode":"String",
"brightness":"Int",
"status":"String"
}
}
Nebula指令请求例子：
{
"func":"getLightStatus",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"mode":"auto",
"brightness":80,
"status":"on"
}
}
setAudioVolume
描述： 设置音频音量
版本： 1.1
指令集： audioControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| type | String | M | 音频类型（speaker/mic/all） |
| volume | Int | M | 音量值（0-100） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"setAudioVolume",
"args":{
"channel":"Int",
"type":"String",
"volume":"Int"
}
}
Nebula指令请求例子：
{
"func":"setAudioVolume",
"args":{
"channel":1,
"type":"speaker",
"volume":75
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getAudioVolume
描述： 获取音频音量
版本： 1.1
指令集： audioControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| type | String | M | 音频类型（speaker/mic/all） |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| volume | Int | M | 当前音量值（0-100） |
Profile定义：
{
"func":"getAudioVolume",
"args":{
"channel":"Int",
"type":"String"
},
"return":{
"volume":"Int"
}
}
Nebula指令请求例子：
{
"func":"getAudioVolume",
"args":{
"channel":1,
"type":"speaker"
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"volume":75
}
}
enableTwoWayAudio
描述： 启用双向音频
版本： 1.1
指令集： audioControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| mode | String | O | 模式（fullDuplex/halfDuplex，默认fullDuplex） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"enableTwoWayAudio",
"args":{
"channel":"Int",
"mode":"String"
}
}
Nebula指令请求例子：
{
"func":"enableTwoWayAudio",
"args":{
"channel":1,
"mode":"fullDuplex"
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
disableTwoWayAudio
描述： 禁用双向音频
版本： 1.1
指令集： audioControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"disableTwoWayAudio",
"args":{
"channel":"Int"
}
}
Nebula指令请求例子：
{
"func":"disableTwoWayAudio",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
setMotionDetection
描述： 设置移动侦测
版本： 1.1
指令集： detection
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| enable | Boolean | M | 是否启用（true/false） |
| sensitivity | Int | O | 灵敏度（1-10，默认5） |
| regions | Array of Int | O | 侦测区域（0-65535，默认全区域） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"setMotionDetection",
"args":{
"channel":"Int",
"enable":"Boolean",
"sensitivity":"Int",
"regions":["Int"]
}
}
Nebula指令请求例子：
{
"func":"setMotionDetection",
"args":{
"channel":1,
"enable":true,
"sensitivity":7,
"regions":[1,2,3]
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getMotionDetection
描述： 获取移动侦测配置
版本： 1.1
指令集： detection
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| enable | Boolean | M | 是否启用 |
| sensitivity | Int | M | 灵敏度（1-10） |
| regions | Array of Int | M | 侦测区域 |
Profile定义：
{
"func":"getMotionDetection",
"args":{
"channel":"Int"
},
"return":{
"enable":"Boolean",
"sensitivity":"Int",
"regions":["Int"]
}
}
Nebula指令请求例子：
{
"func":"getMotionDetection",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"enable":true,
"sensitivity":7,
"regions":[1,2,3]
}
}
setHumanDetection
描述： 设置人形侦测
版本： 1.1
指令集： detection
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| enable | Boolean | M | 是否启用（true/false） |
| sensitivity | Int | O | 识别灵敏度（1-10，默认6） |
| alertEnable | Boolean | O | 是否启用告警（true/false，默认false） |
| regions | Array of Int | O | 侦测区域（0-65535，默认全区域） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"setHumanDetection",
"args":{
"channel":"Int",
"enable":"Boolean",
"sensitivity":"Int",
"alertEnable":"Boolean",
"regions":["Int"]
}
}
Nebula指令请求例子：
{
"func":"setHumanDetection",
"args":{
"channel":1,
"enable":true,
"sensitivity":8,
"alertEnable":true,
"regions":[1,2,3,4]
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getHumanDetection
描述： 获取人形侦测配置
版本： 1.1
指令集： detection
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| enable | Boolean | M | 是否启用人形侦测 |
| sensitivity | Int | M | 识别灵敏度（1-10） |
| alertEnable | Boolean | M | 是否启用告警 |
| regions | Array of Int | M | 侦测区域 |
| detectStatus | Boolean | O | 当前是否检测到人形（实时状态） |
Profile定义：
{
"func":"getHumanDetection",
"args":{
"channel":"Int"
},
"return":{
"enable":"Boolean",
"sensitivity":"Int",
"alertEnable":"Boolean",
"regions":["Int"],
"detectStatus":"Boolean"
}
}
Nebula指令请求例子：
{
"func":"getHumanDetection",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"enable":true,
"sensitivity":8,
"alertEnable":true,
"regions":[1,2,3,4],
"detectStatus":false
}
}
setVideoQuality
描述： 设置视频画质
版本： 1.1
指令集： videoControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| quality | String | M | 画质等级（low/medium/high，对应标清/高清/超清） |
| resolution | String | O | 分辨率（如1080p/720p/480p，默认随画质等级适配） |
| fps | Int | O | 帧率（1-30，默认25） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"setVideoQuality",
"args":{
"channel":"Int",
"quality":"String",
"resolution":"String",
"fps":"Int"
}
}
Nebula指令请求例子：
{
"func":"setVideoQuality",
"args":{
"channel":1,
"quality":"high",
"resolution":"1080p",
"fps":30
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getVideoQuality
描述： 获取视频画质配置
版本： 1.1
指令集： videoControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| quality | String | M | 当前画质等级（low/medium/high） |
| resolution | String | M | 当前分辨率 |
| fps | Int | M | 当前帧率 |
Profile定义：
{
"func":"getVideoQuality",
"args":{
"channel":"Int"
},
"return":{
"quality":"String",
"resolution":"String",
"fps":"Int"
}
}
Nebula指令请求例子：
{
"func":"getVideoQuality",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"quality":"high",
"resolution":"1080p",
"fps":30
}
}
enableMotionAlarm
描述： 启用移动侦测告警
版本： 1.1
指令集： alarmControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| alertType | String | O | 告警类型（sound/light/push/all，默认all） |
| duration | Int | O | 告警持续时长（秒，1-300，默认30） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"enableMotionAlarm",
"args":{
"channel":"Int",
"alertType":"String",
"duration":"Int"
}
}
Nebula指令请求例子：
{
"func":"enableMotionAlarm",
"args":{
"channel":1,
"alertType":"all",
"duration":60
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
disableMotionAlarm
描述： 禁用移动侦测告警
版本： 1.1
指令集： alarmControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"disableMotionAlarm",
"args":{
"channel":"Int"
}
}
Nebula指令请求例子：
{
"func":"disableMotionAlarm",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
enableHumanAlarm
描述： 启用人形侦测告警
版本： 1.1
指令集： alarmControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| alertType | String | O | 告警类型（sound/light/push/all，默认all） |
| sensitivity | Int | O | 告警触发灵敏度（1-10，默认7） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"enableHumanAlarm",
"args":{
"channel":"Int",
"alertType":"String",
"sensitivity":"Int"
}
}
Nebula指令请求例子：
{
"func":"enableHumanAlarm",
"args":{
"channel":1,
"alertType":"push",
"sensitivity":8
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
disableHumanAlarm
描述： 禁用人形侦测告警
版本： 1.1
指令集： alarmControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"disableHumanAlarm",
"args":{
"channel":"Int"
}
}
Nebula指令请求例子：
{
"func":"disableHumanAlarm",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
startRecord
描述： 开始录像
版本： 1.1
指令集： recordControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| recordType | String | O | 录像类型（local/cloud，默认local） |
| duration | Int | O | 录像时长（分钟，1-1440，默认无限时长） |
| quality | String | O | 录像画质（low/medium/high，默认high） |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| recordId | String | M | 录像任务ID（唯一标识） |
Profile定义：
{
"func":"startRecord",
"args":{
"channel":"Int",
"recordType":"String",
"duration":"Int",
"quality":"String"
},
"return":{
"recordId":"String"
}
}
Nebula指令请求例子：
{
"func":"startRecord",
"args":{
"channel":1,
"recordType":"local",
"duration":60,
"quality":"high"
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"recordId":"REC20251219100001CH1"
}
}
stopRecord
描述： 停止录像
版本： 1.1
指令集： recordControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| recordId | String | O | 录像任务ID（为空时停止该通道所有录像） |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| recordDuration | Int | M | 实际录像时长（秒） |
| fileSize | Int | M | 录像文件大小（KB） |
Profile定义：
{
"func":"stopRecord",
"args":{
"channel":"Int",
"recordId":"String"
},
"return":{
"recordDuration":"Int",
"fileSize":"Int"
}
}
Nebula指令请求例子：
{
"func":"stopRecord",
"args":{
"channel":1,
"recordId":"REC20251219100001CH1"
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"recordDuration":3600,
"fileSize":288000
}
}
getRecordStatus
描述： 获取录像状态
版本： 1.1
指令集： recordControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| recordId | String | O | 录像任务ID（为空时查询该通道所有录像状态） |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| status | String | M | 录像状态（recording/idle/error，对应录制中/空闲/异常） |
| currentDuration | Int | M | 当前录像时长（秒，空闲时为0） |
| currentFileSize | Int | M | 当前录像文件大小（KB，空闲时为0） |
| recordType | String | M | 录像类型（local/cloud，空闲时为空） |
Profile定义：
{
"func":"getRecordStatus",
"args":{
"channel":"Int",
"recordId":"String"
},
"return":{
"status":"String",
"currentDuration":"Int",
"currentFileSize":"Int",
"recordType":"String"
}
}
Nebula指令请求例子：
{
"func":"getRecordStatus",
"args":{
"channel":1,
"recordId":"REC20251219100001CH1"
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"status":"recording",
"currentDuration":1800,
"currentFileSize":144000,
"recordType":"local"
}
}
setRecordSchedule
描述： 设置录像计划
版本： 1.1
指令集： recordControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| scheduleType | String | M | 计划类型（timing/motion/human/all，对应定时/移动侦测/人形侦测/全天） |
| startTime | String | O | 开始时间（HH:MM，仅定时计划必填，如08:00） |
| endTime | String | O | 结束时间（HH:MM，仅定时计划必填，如20:00） |
| weekDays | String | O | 生效星期（逗号分隔，如1,3,5，默认全部星期生效） |
| quality | String | O | 计划录像画质（low/medium/high，默认high） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"setRecordSchedule",
"args":{
"channel":"Int",
"scheduleType":"String",
"startTime":"String",
"endTime":"String",
"weekDays":"String",
"quality":"String"
}
}
Nebula指令请求例子：
{
"func":"setRecordSchedule",
"args":{
"channel":1,
"scheduleType":"timing",
"startTime":"08:00",
"endTime":"20:00",
"weekDays":"1,2,3,4,5",
"quality":"medium"
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getRecordSchedule
描述： 获取录像计划配置
版本： 1.1
指令集： recordControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| scheduleType | String | M | 计划类型（timing/motion/human/all） |
| startTime | String | M | 开始时间（HH:MM，非定时计划为空） |
| endTime | String | M | 结束时间（HH:MM，非定时计划为空） |
| weekDays | String | M | 生效星期（逗号分隔） |
| quality | String | M | 计划录像画质（low/medium/high） |
Profile定义：
{
"func":"getRecordSchedule",
"args":{
"channel":"Int"
},
"return":{
"scheduleType":"String",
"startTime":"String",
"endTime":"String",
"weekDays":"String",
"quality":"String"
}
}
Nebula指令请求例子：
{
"func":"getRecordSchedule",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"scheduleType":"timing",
"startTime":"08:00",
"endTime":"20:00",
"weekDays":"1,2,3,4,5",
"quality":"medium"
}
}
enableSoundAlarm
描述： 启用声音告警（独立控制）
版本： 1.1
指令集： alarmControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| soundType | String | O | 告警声音类型（siren/beep/voice，默认siren） |
| volume | Int | O | 告警音量（1-10，默认8） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"enableSoundAlarm",
"args":{
"channel":"Int",
"soundType":"String",
"volume":"Int"
}
}
Nebula指令请求例子：
{
"func":"enableSoundAlarm",
"args":{
"channel":1,
"soundType":"siren",
"volume":9
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
disableSoundAlarm
描述： 禁用声音告警（独立控制）
版本： 1.1
指令集： alarmControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"disableSoundAlarm",
"args":{
"channel":"Int"
}
}
Nebula指令请求例子：
{
"func":"disableSoundAlarm",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
setAlarmSensitivity
描述： 设置告警灵敏度（通用）
版本： 1.1
指令集： alarmControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| alarmType | String | M | 告警类型（motion/human/all，对应移动/人形/全部） |
| sensitivity | Int | M | 灵敏度（1-10，1最低/10最高） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"setAlarmSensitivity",
"args":{
"channel":"Int",
"alarmType":"String",
"sensitivity":"Int"
}
}
Nebula指令请求例子：
{
"func":"setAlarmSensitivity",
"args":{
"channel":1,
"alarmType":"all",
"sensitivity":6
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getAlarmSensitivity
描述： 获取告警灵敏度配置（通用）
版本： 1.1
指令集： alarmControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| alarmType | String | O | 告警类型（motion/human/all，默认all） |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| motionSensitivity | Int | M | 移动侦测灵敏度（1-10） |
| humanSensitivity | Int | M | 人形侦测灵敏度（1-10） |
Profile定义：
{
"func":"getAlarmSensitivity",
"args":{
"channel":"Int",
"alarmType":"String"
},
"return":{
"motionSensitivity":"Int",
"humanSensitivity":"Int"
}
}
Nebula指令请求例子：
{
"func":"getAlarmSensitivity",
"args":{
"channel":1,
"alarmType":"all"
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"motionSensitivity":6,
"humanSensitivity":6
}
}
enableIRCut
描述： 启用红外切换（夜视模式）
版本： 1.1
指令集： videoControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| mode | String | O | 红外模式（auto/manual，默认auto） |
| brightness | Int | O | 红外亮度（1-10，默认7，仅手动模式生效） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"enableIRCut",
"args":{
"channel":"Int",
"mode":"String",
"brightness":"Int"
}
}
Nebula指令请求例子：
{
"func":"enableIRCut",
"args":{
"channel":1,
"mode":"auto",
"brightness":8
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
disableIRCut
描述： 禁用红外切换（关闭夜视模式）
版本： 1.1
指令集： videoControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"disableIRCut",
"args":{
"channel":"Int"
}
}
Nebula指令请求例子：
{
"func":"disableIRCut",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getIRCutStatus
描述： 获取红外切换状态
版本： 1.1
指令集： videoControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| status | String | M | 红外状态（enabled/disabled，对应启用/禁用） |
| mode | String | M | 红外模式（auto/manual，禁用时为空） |
| brightness | Int | M | 红外亮度（1-10，禁用时为0） |
Profile定义：
{
"func":"getIRCutStatus",
"args":{
"channel":"Int"
},
"return":{
"status":"String",
"mode":"String",
"brightness":"Int"
}
}
Nebula指令请求例子：
{
"func":"getIRCutStatus",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"status":"enabled",
"mode":"auto",
"brightness":8
}
}
setVideoRotation
描述： 设置视频旋转角度
版本： 1.1
指令集： videoControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| rotation | Int | M | 旋转角度（0/90/180/270，默认0） |
| mirror | Boolean | O | 是否镜像（true/false，默认false） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"setVideoRotation",
"args":{
"channel":"Int",
"rotation":"Int",
"mirror":"Boolean"
}
}
Nebula指令请求例子：
{
"func":"setVideoRotation",
"args":{
"channel":1,
"rotation":180,
"mirror":false
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getVideoRotation
描述： 获取视频旋转配置
版本： 1.1
指令集： videoControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| rotation | Int | M | 旋转角度（0/90/180/270） |
| mirror | Boolean | M | 是否镜像（true/false） |
Profile定义：
{
"func":"getVideoRotation",
"args":{
"channel":"Int"
},
"return":{
"rotation":"Int",
"mirror":"Boolean"
}
}
Nebula指令请求例子：
{
"func":"getVideoRotation",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"rotation":180,
"mirror":false
}
}
enableSDCardFormat
描述： 启用SD卡格式化
版本： 1.1
指令集： storageControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| formatType | String | O | 格式化类型（quick/full，默认quick） |
| encrypt | Boolean | O | 是否加密格式化（true/false，默认false） |
返回值： 200, 400, 404, 500
返回内容： Empty
Profile定义：
{
"func":"enableSDCardFormat",
"args":{
"formatType":"String",
"encrypt":"Boolean"
}
}
Nebula指令请求例子：
{
"func":"enableSDCardFormat",
"args":{
"formatType":"quick",
"encrypt":false
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getSDCardStatus
描述： 获取SD卡状态
版本： 1.1
指令集： storageControl
请求参数： Empty
返回值： 200, 404, 500
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| status | String | M | SD卡状态（normal/error/unmounted/formating，对应正常/异常/未挂载/格式化中） |
| totalCapacity | Int | M | 总容量（MB，未挂载时为0） |
| usedCapacity | Int | M | 已用容量（MB，未挂载时为0） |
| freeCapacity | Int | M | 剩余容量（MB，未挂载时为0） |
| health | String | M | 健康状态（good/warning/bad，对应良好/警告/损坏） |
Profile定义：
{
"func":"getSDCardStatus",
"args":{},
"return":{
"status":"String",
"totalCapacity":"Int",
"usedCapacity":"Int",
"freeCapacity":"Int",
"health":"String"
}
}
Nebula指令请求例子：
{
"func":"getSDCardStatus",
"args":{}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"status":"normal",
"totalCapacity":32768,
"usedCapacity":15600,
"freeCapacity":17168,
"health":"good"
}
}
setSDCardLoopRecord
描述： 设置SD卡循环录像
版本： 1.1
指令集： storageControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| enable | Boolean | M | 是否启用循环录像（true/false） |
| reserveDays | Int | O | 录像保留天数（1-30，默认7，仅启用时生效） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"setSDCardLoopRecord",
"args":{
"channel":"Int",
"enable":"Boolean",
"reserveDays":"Int"
}
}
Nebula指令请求例子：
{
"func":"setSDCardLoopRecord",
"args":{
"channel":1,
"enable":true,
"reserveDays":7
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getSDCardLoopRecord
描述： 获取SD卡循环录像配置
版本： 1.1
指令集： storageControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| enable | Boolean | M | 是否启用循环录像（true/false） |
| reserveDays | Int | M | 录像保留天数（1-30） |
Profile定义：
{
"func":"getSDCardLoopRecord",
"args":{
"channel":"Int"
},
"return":{
"enable":"Boolean",
"reserveDays":"Int"
}
}
Nebula指令请求例子：
{
"func":"getSDCardLoopRecord",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"enable":true,
"reserveDays":7
}
}
enableCloudRecord
描述： 启用云录像
版本： 1.1
指令集： cloudControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| quality | String | O | 云录像画质（low/medium/high，默认high） |
| reserveDays | Int | O | 云录像保留天数（1-30，默认7） |
返回值： 200, 400, 401, 404
返回内容： Empty
Profile定义：
{
"func":"enableCloudRecord",
"args":{
"channel":"Int",
"quality":"String",
"reserveDays":"Int"
}
}
Nebula指令请求例子：
{
"func":"enableCloudRecord",
"args":{
"channel":1,
"quality":"medium",
"reserveDays":15
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
disableCloudRecord
描述： 禁用云录像
版本： 1.1
指令集： cloudControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 401, 404
返回内容： Empty
Profile定义：
{
"func":"disableCloudRecord",
"args":{
"channel":"Int"
}
}
Nebula指令请求例子：
{
"func":"disableCloudRecord",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getCloudRecordStatus
描述： 获取云录像状态
版本： 1.1
指令集： cloudControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 401, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| status | String | M | 云录像状态（enabled/disabled/expired，对应启用/禁用/过期） |
| quality | String | M | 云录像画质（low/medium/high，禁用/过期时为空） |
| reserveDays | Int | M | 云录像保留天数（禁用/过期时为0） |
| expireTime | String | M | 过期时间（YYYY-MM-DD HH:MM:SS，禁用时为空） |
Profile定义：
{
"func":"getCloudRecordStatus",
"args":{
"channel":"Int"
},
"return":{
"status":"String",
"quality":"String",
"reserveDays":"Int",
"expireTime":"String"
}
}
Nebula指令请求例子：
{
"func":"getCloudRecordStatus",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"status":"enabled",
"quality":"medium",
"reserveDays":15,
"expireTime":"2025-12-31 23:59:59"
}
}
setAlarmNotification
描述： 设置告警通知方式
版本： 1.1
指令集： alarmControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| notificationType | String | M | 通知方式（push/sms/email/all/none，对应推送/短信/邮件/全部/无） |
| sound | Boolean | O | 推送是否带声音（true/false，默认true） |
| vibration | Boolean | O | 推送是否震动（true/false，默认true） |
返回值： 200, 400, 404
返回内容： Empty
Profile定义：
{
"func":"setAlarmNotification",
"args":{
"channel":"Int",
"notificationType":"String",
"sound":"Boolean",
"vibration":"Boolean"
}
}
Nebula指令请求例子：
{
"func":"setAlarmNotification",
"args":{
"channel":1,
"notificationType":"all",
"sound":true,
"vibration":true
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getAlarmNotification
描述： 获取告警通知方式
版本： 1.1
指令集： alarmControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| notificationType | String | M | 通知方式（push/sms/email/all/none） |
| sound | Boolean | M | 推送是否带声音（true/false） |
| vibration | Boolean | M | 推送是否震动（true/false） |
Profile定义：
{
"func":"getAlarmNotification",
"args":{
"channel":"Int"
},
"return":{
"notificationType":"String",
"sound":"Boolean",
"vibration":"Boolean"
}
}
Nebula指令请求例子：
{
"func":"getAlarmNotification",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"notificationType":"all",
"sound":true,
"vibration":true
}
}
enablePTZControl
描述： 启用PTZ控制
版本： 1.1
指令集： ptzControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| timeout | Int | O | PTZ控制超时时间（秒，10-300，默认60） |
返回值： 200, 400, 404, 501
返回内容： Empty
Profile定义：
{
"func":"enablePTZControl",
"args":{
"channel":"Int",
"timeout":"Int"
}
}
Nebula指令请求例子：
{
"func":"enablePTZControl",
"args":{
"channel":1,
"timeout":120
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
setPTZDirection
描述： 设置PTZ转动方向
版本： 1.1
指令集： ptzControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
| direction | String | M | 转动方向（up/down/left/right/stop/zoomIn/zoomOut，对应上/下/左/右/停止/放大/缩小） |
| speed | Int | O | 转动速度（1-10，默认5，停止时无效） |
返回值： 200, 400, 403, 404, 501
返回内容： Empty
Profile定义：
{
"func":"setPTZDirection",
"args":{
"channel":"Int",
"direction":"String",
"speed":"Int"
}
}
Nebula指令请求例子：
{
"func":"setPTZDirection",
"args":{
"channel":1,
"direction":"up",
"speed":6
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK"
}
getPTZStatus
描述： 获取PTZ状态
版本： 1.1
指令集： ptzControl
请求参数：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| channel | Int | M | 通道ID |
返回值： 200, 400, 404, 501
返回内容：
| Parameter name | Data type | Requirement | Description |
|---|---|---|---|
| status | String | M | PTZ状态（idle/moving/error/unavailable，对应空闲/转动中/异常/不支持） |
| currentDirection | String | M | 当前方向（up/down/left/right/stop/zoomIn/zoomOut，空闲时为stop） |
| panAngle | Int | M | 水平角度（0-359，不支持时为-1） |
| tiltAngle | Int | M | 垂直角度（0-90，不支持时为-1） |
| zoomLevel | Int | M | 变焦级别（1-10，1为广角，不支持时为-1） |
Profile定义：
{
"func":"getPTZStatus",
"args":{
"channel":"Int"
},
"return":{
"status":"String",
"currentDirection":"String",
"panAngle":"Int",
"tiltAngle":"Int",
"zoomLevel":"Int"
}
}
Nebula指令请求例子：
{
"func":"getPTZStatus",
"args":{
"channel":1
}
}
Nebula指令回复例子：
{
"statusCode": 200,
"statusMsg": "OK",
"content":{
"status":"idle",
"currentDirection":"stop",
"panAngle":90,
"tiltAngle":45,
"zoomLevel":3
}
}
