服务器REST交互协议 V2.9
2022-8-6
协议格式
发起 http://localhost:port/action? param1=aaa¶m2=bbb&...
默认端口:80
正常返回
{"result": {$result}}
备注:
result=0,返回正常;其他值表示出现错误
目 录
TOC \o "1-3" \h \u HYPERLINK \l _Toc24521 一、 组织树读取协议 6
HYPERLINK \l _Toc3217 1. 读取设备物理组织树协议 6
HYPERLINK \l _Toc10848 2. 读取逻辑分组协议 7
HYPERLINK \l _Toc15208 3. 读取逻辑分组协议V2 8
HYPERLINK \l _Toc1058 4. 根据设备的备注信息查询组织列表协议 9
HYPERLINK \l _Toc17650 5. 分层读取组织列表协议 10
HYPERLINK \l _Toc17978 6. 读取所有摄像机列表协议 11
HYPERLINK \l _Toc31017 7. 根据设备的序列号查询组织列表协议 11
HYPERLINK \l _Toc30258 8. 读取所有摄像机列表协议V2 12
HYPERLINK \l _Toc20230 9. 根据国标ID读取摄像机信息协议 13
HYPERLINK \l _Toc24684 二、 摄像机控制协议 14
HYPERLINK \l _Toc30084 1. PTZ控制协议 14
HYPERLINK \l _Toc17300 2. 预置点控制协议 14
HYPERLINK \l _Toc13775 3. 手动抓拍协议 14
HYPERLINK \l _Toc31878 4. 读取抓拍文件协议 15
HYPERLINK \l _Toc30742 三、 摄像机查询HLS相关URL协议 15
HYPERLINK \l _Toc24186 1. 根据名称搜索相关通道HLS协议 15
HYPERLINK \l _Toc1924 2. 根据设备序列号查询相关通道HLS协议 16
HYPERLINK \l _Toc371 四、 视频设备相关协议 16
HYPERLINK \l _Toc22385 1. 添加设备协议 16
HYPERLINK \l _Toc24900 2. 编辑设备协议 17
HYPERLINK \l _Toc23254 3. 删除设备协议 18
HYPERLINK \l _Toc14764 4. 查询通道在线状态协议 18
HYPERLINK \l _Toc18554 5. 修改通道名称协议 18
HYPERLINK \l _Toc12370 6. 查询主动注册设备列表协议 19
HYPERLINK \l _Toc14711 7. 添加区域协议 19
HYPERLINK \l _Toc9131 8. 按账号查询主动注册设备列表协议 19
HYPERLINK \l _Toc15631 五、 录像相关协议 20
HYPERLINK \l _Toc28182 1. 查询通道录像文件列表协议 20
HYPERLINK \l _Toc5085 2. 开始中心录像协议 20
HYPERLINK \l _Toc9891 3. 结束中心录像协议 21
HYPERLINK \l _Toc5613 4. 查询中心录像状态协议 21
HYPERLINK \l _Toc30061 六、 数字矩阵相关协议 21
HYPERLINK \l _Toc8772 1. 读取数字矩阵主机列表协议 21
HYPERLINK \l _Toc32622 2. 查询电视墙信息协议 22
HYPERLINK \l _Toc11217 3. 查询数字矩阵大屏列表协议 22
HYPERLINK \l _Toc20015 4. 查询数字矩阵窗口列表协议 23
HYPERLINK \l _Toc22258 5. 清除某个显示屏协议 23
HYPERLINK \l _Toc31175 6. 清除显示屏上某个窗口协议 23
HYPERLINK \l _Toc29662 7. 在显示屏上某个窗口打开实时视频协议 24
HYPERLINK \l _Toc20484 8. 控制显示屏上某个窗口全屏动作协议 24
HYPERLINK \l _Toc17854 9. 设置显示屏信息协议 24
HYPERLINK \l _Toc18873 10. 读取数字矩阵主机大屏合并状态协议 25
HYPERLINK \l _Toc17215 11. 设置数字矩阵主机大屏合并状态协议 25
HYPERLINK \l _Toc26490 12. 恢复数字矩阵主机为分屏状态协议 25
HYPERLINK \l _Toc9427 13. 读取矩阵轮巡屏协议 25
HYPERLINK \l _Toc6487 14. 设置矩阵轮巡屏协议 26
HYPERLINK \l _Toc30221 15. 控制矩阵轮巡协议 26
HYPERLINK \l _Toc12629 16. 读取矩阵轮巡状态协议 27
HYPERLINK \l _Toc19122 17. 在显示屏上某个窗口回放视频协议 27
HYPERLINK \l _Toc7854 18. 回放速度协议 27
HYPERLINK \l _Toc32115 19. 停止回放协议 27
HYPERLINK \l _Toc24615 七、 用户管理相关协议 28
HYPERLINK \l _Toc19830 1. 用户登录协议 28
HYPERLINK \l _Toc19960 2. 用户登出协议 28
HYPERLINK \l _Toc6416 3. 读取角色列表协议 28
HYPERLINK \l _Toc8224 4. 添加角色协议 29
HYPERLINK \l _Toc10076 5. 编辑角色协议 29
HYPERLINK \l _Toc31763 6. 删除角色协议 29
HYPERLINK \l _Toc16284 7. 读取指定角色的权限列表协议 30
HYPERLINK \l _Toc27942 8. 添加指定角色的权限协议 30
HYPERLINK \l _Toc1154 9. 删除指定角色的权限协议 30
HYPERLINK \l _Toc1329 10. 读取用户列表协议 31
HYPERLINK \l _Toc31439 11. 添加用户协议 31
HYPERLINK \l _Toc3880 12. 编辑用户协议 32
HYPERLINK \l _Toc7663 13. 删除用户协议 33
HYPERLINK \l _Toc19408 14. 修改当前用户密码协议 33
HYPERLINK \l _Toc14974 八、 AI事件上传协议 34
HYPERLINK \l _Toc12464 1. 上传AI报警事件协议 34
HYPERLINK \l _Toc17876 2. AI报警事件代码定义 34
HYPERLINK \l _Toc9197 九、 28181组织管理相关协议 35
HYPERLINK \l _Toc25352 1. 读取28181组织信息 35
HYPERLINK \l _Toc17336 2. 添加28181组织信息 35
HYPERLINK \l _Toc2321 3. 编辑28181组织信息 36
HYPERLINK \l _Toc32372 4. 删除28181组织信息 37
HYPERLINK \l _Toc6896 十、 28181上行平台管理相关协议 37
HYPERLINK \l _Toc10431 1. 读取28181上行中心列表信息 37
HYPERLINK \l _Toc2555 2. 读取某个28181中心信息 38
HYPERLINK \l _Toc26876 3. 设置某个28181中心信息 38
HYPERLINK \l _Toc7115 4. 删除28181上行中心 39
HYPERLINK \l _Toc19484 5. 读取28181上行节点列表信息 39
HYPERLINK \l _Toc30813 6. 添加28181上行节点信息 40
HYPERLINK \l _Toc13745 7. 删除28181上行节点信息 40
HYPERLINK \l _Toc2653 8. 重启28181服务模块 40
HYPERLINK \l _Toc11665 十一、 视频网关相关协议 41
HYPERLINK \l _Toc19133 1. 网关通道视频打开 41
HYPERLINK \l _Toc24465 2. 网关通道视频关闭 41
HYPERLINK \l _Toc6655 3. 网关通道回放视频打开 42
HYPERLINK \l _Toc1571 4. 网关通道回放视频关闭 42
请求 | http://localhost:port/org/Channels?username={$username}&password={$password}&rtsp={$rtsp}&cascade={$cascade} | |
回复 | { "hostPort": 81, "hostIp": "192.168.1.120", "servicePort": 53403, "serviceIp": "192.168.1.120", "user": "admin", "tree": [ { "items": [ { "items": [ { "channelNo": 0, "valid": 1, "id": 1, "type": 3, "name": "地铁工地", "device": 1, "gbid": "34020000001320000001", "longitude": "120.153576", "latitude": "30.287459", "cameratype": 0, "url": {$url}, "rtspurl": {$rtspurl} } ], "valid": 1, "ip": "192.168.0.45", "id": 1, "type": 2, "port": 53401, "name": "45" } ], "id": 1, "type": 1, "name": "监控区域" } ] } | username 用户名 password 密码 rtsp 是否读取rtsp的url,缺省为0 cascade 启用级联优化模式,缺省为0。如果为1,则本平台下有多个级联平台时,将直接返回级联平台的HLS,用于自动分流 1. type type=1, 区域节点 type=2, 设备节点 type=3, 通道节点 2. channelNo 通道号,当一个设备有多个通道时,区分用 3. valid 是否在线的标志, valid=1, 在线 valid=0, 不在线 4. name 节点的名称,根据type来定,可能是区域名,可能是设备名,也可能是通道名 5. device 设备ID 注意:在手机端或网页控件上打开一个通道时,需要传入的主要是device与channelNo 6. serviceIp 流媒体的IP 7. servicePort 流媒体的端口 8. url HLS的URL 9. rtspurl RTSP的URL(只在rtsp不等于0时才有) cameratype 摄像机的类型:1-球机;2-半球;3-固定枪机;4-遥控枪 gbid 国标ID longitude 经度 latitude 纬度 |
请求 | http://localhost:port/QueryGroup?username={$username}&password={$password} | |
回复 | { "result" :{$result}, "items": [{ "pid" :{$pid}, "index" :{$index}, "id" :{$id}, "name" :{$name}, "channels" :[{"deviceid": {$deviceid}, "channel":{$channel}}], "items": [{...}] }] } | username 用户名 password 密码 pid 分组的父ID,当为顶层分组时为-1 index 在列表中的排序顺序,0表示没有进行逻辑排序 id 分组的ID,数据库产生,唯一值 name 分组的名称 deviceid 设备ID channel 通道号 |
请求 | http://localhost:port/QueryGroupTree?username={$username}&password={$password}&hls={$hls}&rtsp={$rtsp} | |
回复 | { "result" :{$result}, "hostip": {$hostip}, "hostport": {$hostport}, "serviceip": {$serviceip}, "serviceport": {$serviceport}, "user": {$user}, "items": [{ "pid" :{$pid}, "index" :{$index}, "id" :{$id}, "name" :{$name}, "channels" :[{ "deviceid": {$deviceid}, "channel":{$channel}, "name":{$name}, "url": {$url}, "rtspurl": {$rtspurl}, "valid":{$valid} }], "items": [{...}] }] } | username 用户名 password 密码 hls 是否读取hls的url,缺省为0 rtsp 是否读取rtsp的url,缺省为0 hostip 主机端的IP hostport 主机端的端口 serviceip 流媒体的IP serviceport 流媒体的端口 user 登录的用户名 pid 分组的父ID,当为顶层分组时为-1 index 在列表中的排序顺序,0表示没有进行逻辑排序 id 分组的ID,数据库产生,唯一值 name 分组的名称 deviceid 设备ID channel 通道号 name 摄像机名称 url HLS的URL rtspurl RTSP的URL(只在rtsp不等于0时才有) valid 是否在线的标志,valid=1, 在线;valid=0, 不在线 |
请求 | http://localhost:port/QueryOrgTreeByMemo?username={$username}&password={$password}&memo={$memo}&hls={$hls}&rtsp={$rtsp} | |
回复 | { "result" :{$result}, "hostip": {$hostip}, "hostport": {$hostport}, "serviceip": {$serviceip}, "serviceport": {$serviceport}, "user": {$user}, "items": [{ "valid" :{$valid}, "ip" :{$ip}, "port" :{$port}, "id" :{$id}, "name" :{$name}, "path" :{$path}, "channels" :[{ "deviceid": {$deviceid}, "channel":{$channel}, "name":{$name}, "url": {$url}, "rtspurl": {$rtspurl}, "cameratype":{$cameratype}, "gbid": {$gbid}, "longitude": {$longitude}, "latitude": {$latitude}, "valid":{$valid} }], "items": [{...}] }] } | username 用户名 password 密码 hls 是否读取hls的url,缺省为0 rtsp 是否读取rtsp的url,缺省为0 hostip 主机端的IP hostport 主机端的端口 serviceip 流媒体的IP serviceport 流媒体的端口 user 登录的用户名 valid 是否在线的标志,valid=1, 在线;valid=0, 不在线 ip 设备的IP地址 port 设备的端口 id 设备的ID,数据库产生,唯一值 name 设备的名称 path 设备的路径,以"/"区分各级路径 deviceid 设备ID channel 通道号 name 摄像机名称 url HLS的URL rtspurl RTSP的URL(只在rtsp不等于0时才有) cameratype 摄像机的类型:1-球机;2-半球;3-固定枪机;4-遥控枪 gbid 国标ID longitude 经度 latitude 纬度 |
请求 | http://localhost:port/QueryOrgTreeByNode?type={&type}&id={$id}&hls={$hls}&rtsp={$rtsp} | |
回复 | { "result" :{$result}, "items": [{ "valid" :{$valid}, "id" :{$id}, "name" :{$name}, "type" :{$type}, "gbid" :{$gbid}, "longitude": {$longitude}, "latitude": {$latitude}, "cameratype": {$cameratype}, "url": {$url}, "rtspurl": {$rtspurl}, "channel":{$channel} }] } | type 节点类型:1-区域节点,2-设备节点,3-通道节点 id ID,数据库产生(读取顶层区域节点时,可以为-1) hls 是否读取hls的url,缺省为0 rtsp 是否读取rtsp的url,缺省为0 valid 是否在线的标志,valid=1, 在线;valid=0, 不在线 name 节点名称 gbid 下级平台推送过来时的国标ID 以下仅当节点通道时有效 channel 通道号 url HLS的URL(只在hls不等于0时有效) rtspurl RTSP的URL(只在rtsp不等于0时有效) longitude 经度 latitude 纬度 cameratype 摄像机类型:1-球机;2-半球;3-固定枪机;4-遥控枪机 |
请求 | http://localhost:port/QueryChannelList?hls={$hls}&rtsp={$rtsp} | |
回复 | { "result" :{$result}, "hostport": {$hostport}, "hostip": {$hostip}, "serviceport": {$serviceport}, "serviceip": {$serviceip}, "items": [{ "valid" :{$valid}, "id" :{$id}, "name" :{$name}, "type" :{$type}, "gbid" :{$gbid}, "longitude": {$longitude}, "latitude": {$latitude}, "cameratype": {$cameratype}, "url": {$url}, "rtspurl": {$rtspurl}, "channel":{$channel} }] } | hostip 主机端的IP hostport 主机端的端口 serviceip 流媒体的IP serviceport 流媒体的端口 type 节点类型:1-区域节点,2-设备节点,3-通道节点 id 设备ID,数据库产生 hls 是否读取hls的url,缺省为0 rtsp 是否读取rtsp的url,缺省为0 valid 是否在线的标志,valid=1, 在线;valid=0, 不在线 name 节点名称 gbid 下级平台推送过来时的国标ID channel 通道号 url HLS的URL(只在hls不等于0时有效) rtspurl RTSP的URL(只在rtsp不等于0时有效) longitude 经度 latitude 纬度 cameratype 摄像机类型:1-球机;2-半球;3-固定枪机;4-遥控枪 |
请求 | http://localhost:port/QueryOrgTreeBySN?username={$username}&password={$password}&pluginid={$pluginid}&sn={$sn} | |
回复 | { "result" :{$result}, "id": {$id}, "memo": {$memo}, "alias": {$alias}, "channels" :[{ "did": {$did}, "chNo":{$chNo}, "name":{$name}, "id": {$id}, "cameratype":{$cameratype}, "gbid": {$gbid}, "longitude": {$longitude}, "latitude": {$latitude} }] } | username 用户名 password 密码 pluginid 设备厂家的编号,14-海康,16-大华,53-宇视,48-onvif, 50-天地伟业, 36-巨峰/雄迈, 74-海康EHome, 76-rtsp, 103-28181设备/平台 sn 设备的序列号 memo 设备的备注信息,如哪个施工单位等 id 设备或级联平台的ID,数据库产生,唯一值 did 设备ID chNo 通道号 name 摄像机名称 id 通道的ID,数据库产生,唯一值 cameratype 摄像机的类型:1-球机;2-半球;3-固定枪机;4-遥控枪 gbid 国标ID longitude 经度 latitude 纬度 |
请求 | http://localhost:port/QueryChannelListV2?hls={$hls}&rtsp={$rtsp} | |
回复 | { "result" :{$result}, "hostport": {$hostport}, "hostip": {$hostip}, "serviceport": {$serviceport}, "serviceip": {$serviceip}, "items": [{ "valid" :{$valid}, "parentid" :{$parentid}, "parentname" :{$parentname}, "name" :{$name}, "type" :{$type}, "gbid" :{$gbid}, "longitude": {$longitude}, "latitude": {$latitude}, "cameratype": {$cameratype}, "url": {$url}, "rtspurl": {$rtspurl}, "channel":{$channel} }] } | hls 是否读取hls的url,缺省为0 rtsp 是否读取rtsp的url,缺省为0 hostip 主机端的IP hostport 主机端的端口 serviceip 流媒体的IP serviceport 流媒体的端口 type 节点类型:1-区域节点,2-设备节点,3-通道节点 parentname 上级节点的名称 parentid 设备的ID channel 通道号 valid 是否在线的标志,valid=1, 在线;valid=0, 不在线 name 节点名称 gbid 下级平台推送过来时的国标ID url HLS的URL(只在hls不等于0时有效) rtspurl RTSP的URL(只在rtsp不等于0时有效) longitude 经度 latitude 纬度 cameratype 摄像机类型:1-球机;2-半球;3-固定枪机;4-遥控枪 |
请求 | http://localhost:port/QueryChannelInfoByGBID?gbid={$gbid} | |
回复 | { "result" :{$result}, "deviceid" :{$deviceid}, "type" :{$type}, "channel":{$channel} } | type 节点类型:1-区域节点,2-设备节点,3-通道节点 deviceid 设备的ID channel 通道号 gbid 国标ID |
请求 | http://localhost:port/Ptz?deviceid={$deviceid}&channel={$channel}&op={$op}&start={$start}&speed={$speed} | |
回复 | {"result" :{$result}} | deviceid 设备ID channel 通道号 op 0-向上, 1-向下,2-向左, 3-向下, 8-放大, 9-缩小 start 1--开始,0--停止 speed 控制速度,1--10 |
请求 | http://localhost:port/Preset?deviceid={$deviceid}&channel={$channel}&op={$op}¶m={$param} | |
回复 | {"result" :{$result}} | deviceid 设备ID channel 通道号 op 15-设置, 16-调用, 17-删除 param 预置点 |
请求 | http://localhost:port/Snapshot?deviceid={$deviceid}&channel={$channel}&stream={$stream}&direct={&direct} | |
回复 | {"result" :{$result}, "file" :{$file}} | deviceid 设备ID channel 通道号 stream 码流,0--主码流,1--子码流(缺省为子码流) direct 是否直接从设备代理抓拍,1--设备代理抓拍(如海康设备,效率高),0--抓拍代理实现(所有设备都可以)。缺省为0 file 抓拍成功后的文件名,如果失败则为空 |
请求 | http://localhost:port/GetFile?file={$file} | |
回复 | {"result" :{$result}} | file 抓拍成功后的文件名,含完整路径 |
备注 | 如果文件存在,读取成功,则返回文件内容。如果读取失败,则返回如上的json信息。 |
请求 | http://localhost:port/live/Query?username={$username}&password={$password}&treemode={$treemode}&name={$name} | |
回复 | [{"url":{$url},"name":{$channel_name}}] | username 用户名 password 密码 treemode 是否树模式:0-列表方式,1-树形方式 name 区域名或设备名 url HLS的URL channel_name 通道名 notutf8 是否采用UTF8编码返回?0--UTF8, 1-不用UTF8 |
请求 | http://localhost:port/live/QueryBySn?username={$username}&password={$password}&treemode={$treemode}&sn={$sn} | |
回复 | [{"url":{$url},"name":{$channel_name}}] | username 用户名 password 密码 treemode 是否树模式:0-列表方式,1-树形方式 sn 设备的序列号 url HLS的URL channel_name 通道名 notutf8 是否采用UTF8编码返回?0--UTF8, 1-不用UTF8 |
请求 | http://localhost:port/AddVideoDevice?pluginid={$pluginid}&name={$name}&ip={$ip}&port={$port}&sn={$sn}&deviceusername={$deviceusername}&devicepassword={$devicepassword}&path={$path}&username={$username}&password={$password}&memo={$memo} | |
回复 | {"result" :{$result}, "con":{$con}, "id":{$id}, "channels":[{ "name":{$name}, "id":{$id}, "chNo":{$chNo} }]} | pluginid 设备厂家的编号,14-海康,16-大华,53-宇视,48-onvif, 50-天地伟业, 36-巨峰/雄迈, 74-海康EHome, 76-rtsp, 103-28181设备/平台 name 设备名 ip 主机的IP地址(rtsp时为完整的url) port 主机的端口 sn 主机的序列号,可以不填 deviceusername 设备的用户名 devicepassword 设备的密码 username 平台用户名 password 平台密码 memo 设备的备注信息,如哪个施工单位等 path 以"/"区分各级路径。如"test/demo",则是二级路径,test为第一级,demo为第二级 con 连接成功与否:true成功, false失败 id 返回的设备ID name 通道名 id 通道ID chNo 通道号 |
请求 | http://localhost:port/EditVideoDevice?id={$id}&pluginid={$pluginid}&name={$name}&ip={$ip}&port={$port}&sn={$sn}&deviceusername={$deviceusername}&devicepassword={$devicepassword}&username={$username}&password={$password}&memo={$memo} | |
回复 | {"result" :{$result}, "con":{$con}, "id":{$id}, "channels":[{ "name":{$name}, "id":{$chid}, "chNo":{$chNo} }]} | pluginid 设备厂家的编号,14-海康,16-大华,53-宇视,48-onvif, 50-天地伟业, 36-巨峰/雄迈, 76-rtsp, 103-28181设备/平台 name 设备名 ip 主机的IP地址(rtsp时为完整的url) port 主机的端口 sn 主机的序列号,可以不填 deviceusername 设备的用户名 devicepassword 设备的密码 username 平台用户名 password 平台密码 memo 设备的备注信息,如哪个施工单位等 con 连接成功与否:true成功, false失败 id 返回的设备ID name 通道名 chid 通道ID chNo 通道号 |
请求 | http://localhost:port/DelVideoDevice?id={$id}&username={$username}&password={$password}&type={$type} | |
回复 | {"result" :{$result}} | id 设备ID type 节点类型:1--区域(包括28181设备),2--设备,3--通道。缺省为2设备 |
请求 | http://localhost:port/QueryState?deviceid={$deviceid}&channel={$channel} | |
回复 | [{"deviceid":{$deviceid},"channel":{$channel}, "offline":{$offline}}] | deviceid 设备ID号 channel 通道号 offline 在线状态,1-断线,0-在线 |
请求 | http://localhost:port/ChangeChannelName?deviceid={$deviceid}&channel={$channel}&name={$name}&username={$username}&password={$password} | |
回复 | {"result" :{$result}} | deviceid 设备ID号 channel 通道号 name 通道名 username 平台用户名 password 平台密码 |
请求 | http://localhost:port/QueryAutoRegisterDeviceList?online={$online}&used={$used} | |
回复 | {"result" :{$result}, "list" :[{"ip":{$ip}, "port":{$port}, "plugin":{$plugin}, "sid":{$sid}, "sn":{$sn}, "online":{$online}, "used":{$used} }]} | ip 设备IP port 设备端口 plugin 设备的插件类型 sid 设备ID号 sn 序列号(这个是添加设备到管理时的主要参数) online 在线状态,1-在线,0-离线,-1表示所有(作为参数传入时用) used 是否已经加入管理,1-已管理,0-未管理,-1表示所有(作为参数传入时用) |
请求 | http://localhost:port/AddAreaNode?path={$path}&username={$username}&password={$password} | |
回复 | { "result" :{$result}, "id":{$id} } | username 平台用户名 password 平台密码 path 以"/"区分各级路径。如"test/demo",则是二级路径,test为第一级,demo为第二级 id 返回的区域ID |
请求 | http://localhost:port/QueryAutoRegisterDeviceListByAccount?online={$online}&username={$username}&password={$password} | |
回复 | {"result" :{$result}, "list" :[{"ip":{$ip}, "port":{$port}, "plugin":{$plugin}, "id":{$id}, "sn":{$sn}, "online":{$online}, "name":{$name}, "path":{$path} }]} | online 在线状态,1-在线,0-离线,-1表示所有(作为参数传入时用) username 用户名 passsword 密码 ip 设备IP port 设备端口 plugin 设备的插件类型 id 设备的ID,数据库产生,唯一值 sn 序列号(这个是添加设备到管理时的主要参数) name 设备名称 path 设备的路径,以"/"区分各级路径 |
请求 | http://localhost:port/QueryRecord?deviceid={$deviceid}&channel={$channel}&mode={$mode}&start={$start}&stop={$stop} | |
回复 | {"result" :{$result}, "data":[{"deviceid":{$deviceid},"channel":{$channel}, "start":{$start}, "stop":{$stop}}]} | deviceid 设备ID号 channel 通道号 mode 录像文件类型:1-设备前端,2-中心录像 start 开始时间,格式如:20200210_080000 stop 结束时间,格式同start |
请求 | http://localhost:port/StartCenterRecord?deviceid={$deviceid}&channel={$channel}&delay={$delay} | |
回复 | {"result" :{$result}} | deviceid 设备ID号 channel 通道号 delay 录像延时多久自动停止,单位为秒,-1表示一直录像 |
请求 | http://localhost:port/StopCenterRecord?deviceid={$deviceid}&channel={$channel} | |
回复 | {"result" :{$result}} | deviceid 设备ID号 channel 通道号 |
请求 | http://localhost:port/QueryCenterRecordStatus?channels={$channels} | |
回复 | {"result":{$result}, "status": [ {"deviceid": {$deviceid}, "channel": {$channel}, "status": {$status} ]} | channels 通道列表信息,格式如“deviceid.channel,deviceid.channel”,一次查询多个通道信息 deviceid 设备的id channel 通道号 status 录像状态信息,1---正在录像,0---未录像 |
请求 | http://localhost:port/QueryMatrixHostList | |
回复 | [{ "id":{$id}, "name":{$name}, "plugin":{$plugin}, "ip":{$ip}, "port":{$port}, "username":{$userame}, "password":{$password}, "rowcount":{$rowcount}, "colcount":{$colcount} }] | id 矩阵主机的数据库ID username 用户名 password 密码 name 设备名 plugin 设备厂家的编号,1-D系列,4-A系列,5-H系列,6-T系列 ip 主机的IP地址 port 主机的端口 rowcount 矩阵主机的行数 colcount 矩阵主机的列数 |
请求 | http://localhost:port/QueryMatrixWall | |
回复 | {"result" :{$result}, "row":{$row}, "col":{$col}, "info":{$info} } | row 行数 col 列数 info 信息,参见22 |
请求 | http://localhost:port/QueryMatrixMonitorList | |
回复 | {"result" :{$result}, "data":[{ "id":{$id}, "name":{$name}, "hostid":{$hostid}, "number":{$number}, "windowcount":{$ windowcount}, "alarmenable":{$alarmenable}, "alarmcount":{$ alarmcount}, "splitId":{$splitId} }]} | id 显示器的数据库ID name 显示器的名称 hostid 显示器从属的主机ID number 显示器在从属主机上的输出号(1--Max) windowcount 显示器的窗口分割数 alarmenable 是否允许报警时显示用 alarmcount 报警时显示的画面分割数 splitId 在电视墙上的序号(1--Max) |
请求 | http://localhost:port/QueryMatrixWindowList | |
回复 | {"result" :{$result}, "data":[{ "id":{$id}, "monitorid":{$monitorid}, "number":{$ number}, "did":{$ did}, "chno":{$ chno} }]} | id 窗口的数据库ID monitorid 显示器ID number 在显示器上的窗口编号 did 关联的设备ID chno 关联的通道号 |
请求 | http://localhost:port/ClearMatrixMonitor?monitorid={$monitorid} | |
回复 | {"result" :{$result}} | monitorid 显示器ID |
请求 | http://localhost:port/ClearMatrixWindow?monitorid={$monitorid}&number={$number} | |
回复 | {"result" :{$result}} | monitorid 显示器ID number 在显示器上的窗口编号(0--Max) |
请求 | http://localhost:port/SetMatrixWindow?monitorid={$monitorid}&number={$number}&did={$did}&chno={chno} | |
回复 | {"result" :{$result}} | monitorid 显示器ID number 在显示器上的窗口编号(0--Max) did 关联的设备ID chno 关联的通道号 |
请求 | http://localhost:port/SetMatrixWindowFullScreen?monitorid={$monitorid}&number={$number}&eventcode={$eventcode} | |
回复 | {"result" :{$result}} | monitorid 显示器ID number 在显示器上的窗口编号(0--Max) eventcode 控制代码,1—放大到全屏,0—恢复到小画面 |
请求 | http://localhost:port/SetMatrixMonitor?monitorid={$monitorid}&hostid={$hostid}&number={$number}&windowcount={$windowcount}&alarmenable={$alarmenable}&alarmcount={$alarmcount}&splitId={$splitId}&name={$name} | |
回复 | {"result" :{$result}} | monitorid 显示器ID name 显示器的名称 hostid 显示器从属的主机ID number 显示器在从属主机上的输出号(1--Max) windowcount 显示器的窗口分割数 alarmenable 是否允许报警时显示用 alarmcount 报警时显示的画面分割数 splitId 在电视墙上的序号 |
请求 | http://localhost:port/ReadWallMergeStatus?hostid={$hostid} | |
回复 | {"result" :{$result}, "list":[{"no":{$no}, "status":{$status}}] } | hostid 显示器从属的主机ID no 大屏序号 status 大屏对应的屏号。未合并情况下,屏1 对应1,屏2 对应2;若1,2 合并了,则屏1对应1,屏2 也对应1…… |
请求 | http://localhost:port/SetWallMergeStatus?data={$data} | |
回复 | {"result" :{$result}} | data为json数据,内容如下: { "id":{$id}, //矩阵主机的数据库ID "status":[{"no":{$no}, //大屏序号 "status":{$status}}] //大屏对应的屏号。未合并情况下,屏1 对应1,屏2 对应2;若1,2 合并了,则屏1对应1,屏2 也对应1…… } |
请求 | http://localhost:port/ResetWallMergeStatus?hostid={$hostid} | |
回复 | {"result" :{$result}} | hostid 显示器从属的主机ID |
请求 | http://localhost:port/ReadWallScanMonitorList | |
回复 | {"result" :{$result}, "list":[ { "id":{$id}, "monitorid":{$monitorid}, "enabled":{$enabled}, "windowcount":{$windowcount}, "delay":{$delay}, "channels":{$channels} } ]} | id 数据库ID monitorid 大屏的数据库ID enabled 是否启用 windowcount 轮巡时的画面数 delay 轮巡间隔,单位为秒 channels //具体参与轮巡的通道信息,格式为以逗号分隔如 "A,B,C",每一个细项又是如"deviceid.channel" |
请求 | http://localhost:port/SetWallScanMonitor?id={$id}&monitorid={$monitorid}&enabled={$enabled}&windowcount={$windowcount}&delay={$delay}&channels={$channels} | |
回复 | {"result" :{$result}} | id 数据库ID monitorid 大屏的数据库ID enabled 是否启用 windowcount 轮巡时的画面数 delay 轮巡间隔,单位为秒 channels //具体参与轮巡的通道信息,格式为以逗号分隔如 "A,B,C",每一个细项又是如"deviceid.channel" |
请求 | http://localhost:port/ControlWallScan?code={$code} | |
回复 | {"result" :{$result}} | code 0,关闭轮巡;1,开启轮巡 |
请求 | http://localhost:port/ReadWallScanStatus | |
回复 | {"result" :{$result}, "status" :{$status}} | status 0,没有轮巡;1,正在轮巡;-1,没有轮巡屏 |
请求 | http://localhost:port/SetMatrixWindowVod?monitorid={$monitorid}&number={$number}&did={$did}&chno={chno}&begin={$begin}&end={$end)¢er={$center) | |
回复 | {"result" :{$result}} | monitorid 显示器ID number 在显示器上的窗口编号(0--Max) did 关联的设备ID chno 关联的通道号 begin 录像的开始时间,格式为yyyymmddhhnnss end 录像的结束时间,格式为yyyymmddhhnnss center 是否中心录像,0--设备端录像,1--中心录像 |
请求 | http://localhost:port/SetVodSpeed?monitorid={$monitorid}&number={$number}&speed={$speed} | |
回复 | {"result" :{$result}} | monitorid 显示器ID number 在显示器上的窗口编号(0--Max) speed 播放速度,从1/16X至16X,缺省为1X |
请求 | http://localhost:port/StopVod?monitorid={$monitorid}&number={$number} | |
回复 | {"result" :{$result}} | monitorid 显示器ID number 在显示器上的窗口编号(0--Max) |
请求 | http://localhost:port/LoginToService?username={$username}&password={$password} | |
回复 | {"result" :{$result}, "token" :{$token} } | username 用户名 password 密码 token 访问令牌,后续用户相关协议都需要此令牌。之前的命令中带用户名密码访问的,也可以用此token代替。 |
请求 | http://localhost:port/LogoutService?token={$token} | |
回复 | {"result" :{$result}} | token 访问令牌,登出后即失效 |
请求 | http://localhost:port/QueryRoleList?token={$token} | |
回复 | {"result" :{$result}, "list":[{ "id":{$id}, "name":{$name}, "type":{$type}, "group":{$group}, "module":{$module} }]} | id 数据库ID name 角色名 type 角色类型:0--超级用户,1--管理员,2--普通用户 group 逻辑分组的权限,-1表示所有分组 module 客户端界面模块的权限,-1表示所有模块 |
请求 | http://localhost:port/AddRole?type={$type}&name={$name}&group={$group}&module={$module}&token={$token} | |
回复 | { "result":{$result}, "id":{$id} } | id 数据库ID name 角色名 type 角色类型:1--管理员,2--普通用户 group 逻辑分组的权限,-1表示所有分组 module 客户端界面模块的权限,-1表示所有模块 |
备注 | 不能添加超级用户,超级用户只有一个 |
请求 | http://localhost:port/EditRole?id={$id}&type={$type}&name={$name}&group={$group}&module={$module}&token={$token} | |
回复 | { "result":{$result} } | id 数据库ID name 角色名 type 角色类型:1--管理员,2--普通用户 group 逻辑分组的权限,-1表示所有分组 module 客户端界面模块的权限,-1表示所有模块 |
请求 | http://localhost:port/DeleteRole?id={$id}&token={$token} | |
回复 | { "result":{$result} } | id 数据库ID |
请求 | http://localhost:port/ReadRoleRightList?roleid={$roleid}&token={$token} | |
回复 | {"result" :{$result}, "list":[{ "id":{$id}, "type":{$type}, "dbid":{$dbid}, "system":{$system}, "black":{$black} }]} | roleid 角色的ID id 数据库ID type 类型:0--区域,1--设备,2--通道,3--子系统,4--防区 dbid 上面类型对应的真实数据库ID system 系统类型:0--视频,1--报警主机,2--门禁... black 是否黑名单,1—黑名单,0—白名单 |
请求 | http://localhost:port/AddRoleRight?roleid={$roleid}&type={$type}&dbid={$dbid}&system={$system}&black={$black}&token={$token} | |
回复 | { "result":{$result}, "id":{$id} } | roleid 角色的ID id 数据库ID type 类型:0--区域,1--设备,2--通道,3--子系统,4--防区 dbid 上面类型对应的真实数据库ID system 系统类型:0--视频,1--报警主机,2--门禁... black 是否黑名单,1—黑名单,0—白名单 |
请求 | http://localhost:port/DeleteRoleRight?roleid={$roleid}&id={$id}&token={$token} | |
回复 | {"result":{$result}} | roleid 角色的ID id 数据库ID |
请求 | http://localhost:port/ReadUserList?token={$token} | |
回复 | {"result" :{$result}, "list":[{ "id":{$id}, "userid":{$userid} "name":{$name}, "role":{$role}, "level":{$level}, "createtime":{$createtime}, "begin":{$begin}, "end":{$end}, "sex":{$sex}, "email":{$email}, "cardtype":{$cardtype}, "cardid":{$cardid}, "tel":{$tel}, "mobile":{$mobile}, "status":{$status}, "onlyone":{$onlyone}, "memo":{$memo} }]} | id 数据库ID userid 登录用的ID,最大长度20字节 name 用户名,友好显示名 role 用户所属的角色 以逗号分隔,角色的ID level 用户等级 createtime 创建日期 begin 有效起始日期,如2018-09-11 08:00:00,可以为空 end 有效结束日期 sex 性别 0-male 1-female email 联系邮箱 cardtype 证件类型 0-身份证, 1-驾驶证.... cardid 证件号码 tel 联系电话 mobile 手机号码 status 状态,1—有效,0—无效 onlyone 是否只允许登录一个地方 memo 备注 |
请求 | http://localhost:port/AddUser?userid={$userid}&name={$name}&password={$password}&role={$role}&level={$level}&begin={$begin}&end={$end}&sex={$sex}&email={$email}&cardtype={$cardtype}&cardid={$cardid}&tel={$tel}&mobile={$mobile}&onlyone={$onlyone}&memo={$memo}&token={$token} | |
回复 | { "result":{$result}, "status":{$status}, "id":{$id} } | id 数据库ID userid 登录用的ID,最大长度20字节 name 用户名,友好显示名 password 密码(最大长度40字节) role 用户所属的角色 以逗号分隔,角色的ID level 用户等级 begin 有效起始日期,如2018-09-11 08:00:00 end 有效结束日期 sex 性别 0-male 1-female email 创建日期 cardtype 证件类型 0-身份证, 1-驾驶证.... cardid 证件号码 tel 联系电话 mobile 手机号码 onlyone 是否只允许登录一个地方 memo 备注 status 状态,1—有效,0—无效 |
请求 | http://localhost:port/EditUser?id={$id}&userid={$userid}&name={$name}&password={$password}&role={$role}&level={$level}&begin={$begin}&end={$end}&sex={$sex}&email={$email}&cardtype={$cardtype}&cardid={$cardid}&tel={$tel}&mobile={$mobile}&onlyone={$onlyone}&memo={$memo}&token={$token} | |
回复 | { "result":{$result}, "status":{$status} } | id 数据库ID userid 登录用的ID,最大长度20字节 name 用户名,友好显示名 password 密码(最大长度40字节) role 用户所属的角色 以逗号分隔,角色的ID level 用户等级 begin 有效起始日期,如2018-09-11 08:00:00 end 有效结束日期 sex 性别 0-male 1-female email 创建日期 cardtype 证件类型 0-身份证, 1-驾驶证.... cardid 证件号码 tel 联系电话 mobile 手机号码 onlyone 是否只允许登录一个地方 memo 备注 status 状态,1—有效,0—无效 |
请求 | http://localhost:port/DeleteUser?id={$id}&token={$token} | |
回复 | {"result":{$result}} | id 数据库ID |
请求 | http://localhost:port/ChangeUserPassword?token={$token}&password={$password} | |
回复 | {"result":{$result}} | password 新密码(最大长度40字节) |
请求 | http://localhost:port/UploadAIEvent?serverid={$serverid}&channel={$channel}&eventid={$eventid}&event={$event}&imgfile={$imgfile}&memo={$memo} | |
回复 | {"result" :{$result}} | serverid 平台分配给AI分析设备的ID channel AI分析通道号 eventid AI分析到的报警事件代码,若不在范围内用-1 event AI分析到的报警事件名称 imgfile base64编码的图片文件信息 memo 事件的备注信息 |
备注 | HTTP请求方式--POST |
#define rmAlmPerimeter 15 //周界报警
#define rmAlmVCA_High_Density 16 //区域内人员聚集
#define rmAlmVCA_Violent_Motion 17 //剧烈运动检测
#define rmAlmVCA_Fall_Down 18 //倒地检测
#define rmAlmVCA_Traverse_Plane 19 //穿越警戒面
#define rmAlmVCA_Enter_Area 20 //目标进入区域
#define rmAlmVCA_Exit_Area 21 //目标离开区域
#define rmAlmVCA_Left 22 //物品遗留
#define rmAlmVCA_Take 23 //物品拿取
#define rmAlmVCA_Loiter 24 //徘徊
#define rmAlmVCA_Turbine 1000 //轮机异常
此处信息,会不断完善......
请求 | http://localhost:port/list28181org?token={$token} | |
回复 | { "result": {$result}, "list":[{ "id": {$id}, "orgtype": {$orgtype}, "orgid": {orgid}, "28181id":{$28181id}, "owner": {$owner}, "civilcode": {$civilcode}, "block": {$block}, "address": {$address}, "longitude": {$longitude}, "latitude": {$latitude} }] } | token 访问令牌,登出后即失效 id 数据库的ID orgtype 组织类型:1--区域, 2--设备, 3--摄像机 orgid 相应组织在数据库中的ID 28181id 28181的ID owner 设备归属 civilcode 行政区域 block 警区 address 安装地址 longitude 经度 latitude 纬度 |
请求 | http://localhost:port/add28181org?data={$data}&token={$token} | |
{ "orgtype": {$orgtype}, "orgid": {orgid}, "28181id":{$28181id}, "owner": {$owner}, "civilcode": {$civilcode}, "block": {$block}, "address": {$address}, "longitude": {$longitude}, "latitude": {$latitude} } | token 访问令牌,登出后即失效 id 数据库的ID orgtype 组织类型:1--区域, 2--设备, 3--摄像机 orgid 相应组织在数据库中的ID 28181id 28181的ID owner 设备归属 civilcode 行政区域 block 警区 address 安装地址 longitude 经度 latitude 纬度 | |
回复 | {"result": {$result}, "id": {$id}} |
注: data为json格式,utf8编码
请求 | http://localhost:port/edit28181org?data={$data}&token={$token} | |
{ "id": {$id}, "orgtype": {$orgtype}, "orgid": {orgid}, "28181id":{$28181id}, "owner": {$owner}, "civilcode": {$civilcode}, "block": {$block}, "address": {$address}, "longitude": {$longitude}, "latitude": {$latitude} } | token 访问令牌,登出后即失效 id 数据库的ID orgtype 组织类型:1--区域, 2--设备, 3--摄像机 orgid 相应组织在数据库中的ID 28181id 28181的ID owner 设备归属 civilcode 行政区域 block 警区 address 安装地址 longitude 经度 latitude 纬度 | |
回复 | {"result": {$result}} |
注: data为json格式,utf8编码
请求 | http://localhost:port/del28181org?id={$id}&token={$token} | |
回复 | {"result": {$result}} |
请求 | http://localhost:port/list28181serverinfo?token={$token} | |
回复 | { "result": {$result}, "list":[{ "no":{$no}, "enabled": {$enabled}, "text": {$text}, "ip": {$ip}, "port":{$port}, "cmdmode": {$cmdmode}, "datamode": {$datamode}, "serverid" :{$serverid}, "deviceid": {deviceid}, "password": {$password}, "domain": {$domain}, "createtime": {$createtime}, "updatetime": {$updatetime} }]} | no 中心的序号(基数为0) enabled 是否启用 text 中心的名称 ip 上层平台的IP port 上层平台的28181服务端口,缺省为5060 cmdmode 信令通讯模式:0--udp, 1--tcp datamode 视频通讯模式:0--udp, 1--tcp serverid 上层平台的ID deviceid 上层平台分配给本平台的ID password 向上注册时的密码 domain 域 createtime 创建时间 updatetime 最近更新时间 |
请求 | http://localhost:port/get28181serverinfo?no={$no}&token={$token} | |
回复 | { "result": {$result}, "enabled": {$enabled}, "text": {$text}, "ip": {$ip}, "port":{$port}, "cmdmode": {$cmdmode}, "datamode": {$datamode}, "serverid" :{$serverid}, "deviceid": {deviceid}, "password": {$password}, "domain": {$domain}, "createtime": {$createtime}, "updatetime": {$updatetime} } | no 中心的序号(基数为0) token 访问令牌,登出后即失效 enabled 是否启用 text 中心的名称 ip 上层平台的IP port 上层平台的28181服务端口,缺省为5060 cmdmode 信令通讯模式:0--udp, 1--tcp datamode 视频通讯模式:0--udp, 1--tcp serverid 上层平台的ID deviceid 上层平台分配给本平台的ID password 向上注册时的密码 domain 域 createtime 创建时间 updatetime 最近更新时间 |
请求 | http://localhost:port/set28181serverinfo?no={$no}&data={$data}&token={$token} | |
{ "enabled": {$enabled}, "text": {$text}, "ip": {$ip}, "port":{$port}, "cmdmode": {$cmdmode}, "datamode": {$datamode}, "serverid" :{$serverid}, "deviceid": {deviceid}, "password": {$password}, "domain": {$domain} } | no 中心的序号(基数为0) token 访问令牌,登出后即失效 enabled 是否启用 text 中心的名称 ip 上层平台的IP port 上层平台的28181服务端口,缺省为5060 cmdmode 信令通讯模式:0--udp, 1--tcp datamode 视频通讯模式:0--udp, 1--tcp serverid 上层平台的ID deviceid 上层平台分配给本平台的ID password 向上注册时的密码 domain 域 | |
回复 | {"result": {$result}} |
请求 | http://localhost:port/del28181serverinfo?no={$no}&token={$token} | |
回复 | {"result": {$result}} | no 中心的序号(基数为0) token 访问令牌,登出后即失效 |
请求 | http://localhost:port/list28181uploadnode?token={$token}&no={$no} | |
回复 | { "result": {$result}, "list":[{ "id": {$id}, "orgtype": {$orgtype}, "orgid": {orgid}, "no": {$no} }] } | no 中心的序号(基数为0) token 访问令牌,登出后即失效 id 数据库的ID orgtype 组织类型:1--区域, 2--设备, 3--摄像机 orgid 相应组织在数据库中的ID |
请求 | http://localhost:port/add28181uploadnode?no={$no}&data={$data)&token={$token} | |
{ "orgtype": {$orgtype}, "orgid": {orgid}, } | no 中心的序号(基数为0) token 访问令牌,登出后即失效 id 数据库的ID orgtype 组织类型:1--区域, 2--设备, 3--摄像机 orgid 相应组织在数据库中的ID | |
回复 | {"result": {$result}, "id": {$id}} |
注: data为json格式,utf8编码
请求 | http://localhost:port/del28181uploadnode?no={$no}&id={$id}&token={$token} | |
回复 | {"result": {$result}} | no 中心的序号(基数为0) token 访问令牌,登出后即失效 id 数据库的ID |
请求 | http://localhost:port/restart28181service?token={$token} | |
回复 | {"result": {$result}} | token 访问令牌,登出后即失效 |
请求 | http://localhost:port/openliveproxy?deviceid={$deviceid}&channel={$channel}&stream={$stream}&mode={$mode}&ip={$ip}&port={$port}&ssrc={$ssrc} | |
回复 | {"result": {$result}, "sendip": {$sendip}, "sendport": {sendport}, "ssrc": {$ssrc}, "mode": {$mode}, "tag": {tag} } | deviceid 设备ID channel 通道号 stream 码流,0--主码流,1--子码流(缺省为子码流) mode 模式:0--TCP, 1--UDP,缺省TCP ip 接收数据的IP port 接收数据的端口 sendip 发送端的IP sendport 发送端的端口 ssrc 发送端的SSRC tag 发送端的Tag |
请求 | http://localhost:port/closeliveproxy?deviceid={$deviceid}&channel={$channel}&stream={$stream}&tag={$tag} | |
回复 | {"result": {$result}} | deviceid 设备ID channel 通道号 stream 码流,0--主码流,1--子码流(缺省为子码流) tag 发送端的Tag |
请求 | http://localhost:port/openvodproxy?deviceid={$deviceid}&channel={$channel}&begin={$begin}&end={$end}&mode={$mode}&ip={$ip}&port={$port}&ssrc={$ssrc} | |
回复 | {"result": {$result}, "sendip": {$sendip}, "sendport": {sendport}, "ssrc": {$ssrc}, "mode": {$mode}, "tag": {tag} } | deviceid 设备ID channel 通道号 begin 开始时间,格式如:20200210_080000 end 结束时间,格式同begin mode 模式:0--TCP, 1--UDP,缺省TCP ip 接收数据的IP port 接收数据的端口 sendip 发送端的IP sendport 发送端的端口 ssrc 发送端的SSRC tag 发送端的Tag |
请求 | http://localhost:port/closevodproxy?tag={$tag} | |
回复 | {"result": {$result}} | tag 发送端的Tag |
如果您对我们的产品有兴趣,或者需要咨询的,请联系凌工:18664589394
也可以扫描下面的二维码添加VX
专注于信息技术、通信技术、可视化技术深度融合
为企业提供视频大数据赋能、AI赋能
使企业成为一流的信息化解决方案提供商,数字化融合技术服务商