ES Documentation

网络随身摄像机管理 MQTT 示例

网络随身摄像机 WebRTC 直播 MQTT 示例

简体中文

网络随身摄像机管理 MQTT 示例

网络随身摄像机 WebRTC 直播 MQTT 示例

简体中文

ES Documentation

网络随身摄像机

升级手册

维护手册

管理手册

用户手册

采集服务器

安装手册

升级手册

维护手册

管理手册

用户手册

中心服务器

BCMS 智能执法视频管理平台 —— 企业级执法音视频管理与安全管控系统

更新日志

安装手册

升级手册

维护手册

管理手册

用户手册

开发手册

机构场景 App 接口文档

接入指南

接入指南与公共约定

认证与空间

MQTT 连接与消息边界

Janus 信令边界

数据类型与时间

错误响应差异

验证状态与依据

接口

接入与账户

用户名登录

手机号登录

获取验证码随机数

发送邮箱验证码

发送短信验证码

手机号注册

邮箱找回密码

手机号找回密码

工作空间与权限

恢复登录态

读取可切换租户

组织与人员

组织与人员字段模型

查询雇员—用户关联列表

分页查询雇员—用户关联

按 ID 读取雇员—用户关联

建立雇员—用户关联

更换关联的雇员

删除一个雇员—用户关联

批量删除雇员—用户关联

查询雇员列表

分页查询雇员

按 ID 读取雇员

创建雇员并绑定用户

更新雇员及用户绑定

删除一个雇员

批量删除雇员

查询用户的角色关联

查询角色列表

分页查询角色

按 ID 读取角色及权限

创建角色并配置权限

更新角色及权限

删除一个角色

批量删除角色

异步导入机构列表

查询机构列表

读取当前租户的机构树缓存

分页查询机构

按 ID 读取机构

删除一个机构

批量删除机构

查询租户列表

读取可见租户树

分页查询租户

创建租户并绑定管理用户

更新租户及管理用户

删除一个租户

批量删除租户

查询用户列表

分页查询用户

按 ID 读取用户

创建用户并加入当前租户

更新用户资料与授权关系

删除一个用户

批量删除用户

按条件统计用户

设备与资产

设备与资产字段模型

异步导入数据采集设备列表

查询数据采集设备列表

查询缓存数据采集设备列表

分页查询数据采集设备

按 ID 读取数据采集设备

创建数据采集设备

更新数据采集设备

删除一个数据采集设备

批量删除数据采集设备

查询数据采集设备型号列表

分页查询数据采集设备型号

按 ID 读取数据采集设备型号

创建数据采集设备型号

更新数据采集设备型号

删除一个数据采集设备型号

批量删除数据采集设备型号

异步导入数据采集服务器列表

查询数据采集服务器列表

查询缓存数据采集服务器列表

分页查询数据采集服务器

按 ID 读取数据采集服务器

创建数据采集服务器

更新数据采集服务器

删除一个数据采集服务器

批量删除数据采集服务器

查询数据采集服务器型号列表

分页查询数据采集服务器型号

按 ID 读取数据采集服务器型号

创建数据采集服务器型号

更新数据采集服务器型号

删除一个数据采集服务器型号

批量删除数据采集服务器型号

查询采集服务器—采集设备绑定列表

分页查询采集服务器—采集设备绑定

按 ID 读取采集服务器—采集设备绑定

创建采集服务器—采集设备绑定

更新采集服务器—采集设备绑定

删除一个采集服务器—采集设备绑定

批量删除采集服务器—采集设备绑定

查询数据采集盒列表

分页查询数据采集盒

按 ID 读取数据采集盒

创建数据采集盒

更新数据采集盒

删除一个数据采集盒

批量删除数据采集盒

查询数据采集盒型号列表

分页查询数据采集盒型号

按 ID 读取数据采集盒型号

创建数据采集盒型号

更新数据采集盒型号

删除一个数据采集盒型号

批量删除数据采集盒型号

查询设备类型列表

分页查询设备类型

按 ID 读取设备类型

创建设备类型

更新设备类型

删除一个设备类型

批量删除设备类型

查询设备厂商列表

分页查询设备厂商

按 ID 读取设备厂商

创建设备厂商

更新设备厂商

删除一个设备厂商

批量删除设备厂商

查询缓存Janus 服务器列表

分页查询Janus 服务器

按 ID 读取Janus 服务器

创建Janus 服务器

更新Janus 服务器

删除一个Janus 服务器

批量删除Janus 服务器

查询固件包列表

分页查询固件包

按 ID 读取固件包

创建固件包

更新固件包

删除一个固件包

批量删除固件包

创建SpiritCam 固件

更新SpiritCam 固件

以 Tus 上传固件文件

下载固件文件

对讲群组

新建对讲群组（含成员绑定）

编辑对讲群组（含成员变更）

批量删除对讲群组

分页查询对讲群组视角的成员（pageForTalkGroup）

查询单台记录仪的群组绑定（getByDataAcquisitionDeviceId）

按设备更新群组绑定（updateByDataAcquisitionDeviceIdWithTalkGroups）

确保对讲房间存在（ensureRoom）

刷新设备 PTT 配置（pushPttConfig）

查询对讲相关端在线状态（list-online-status）

查询对讲房间 ICE 服务器（list-ice-server）

Janus 会话生命周期（create / keepalive / destroy）

挂载 AudioBridge 插件（attach）

加入对讲房间（AudioBridge join）

建立 WebRTC 音频（AudioBridge configure + JSEP answer）

离开对讲房间（AudioBridge leave）

拉取房间成员快照（AudioBridge listparticipants）

发送 ICE 候选（AudioBridge trickle）

对讲房间主动事件（participantsChanged / participantLeft / trickle / sessionTerminal / livenessProof）

通知设备加入/退出对讲房间（ptt deliver join/kick）

实时监看

探测设备直播状态与媒体配置（ping / media）

与设备直连协商直播流（P2P call / sdp / candidate / bye）

控制设备 SFU 直播起播与关键帧（play / idr）

创建并保活 Janus 直播会话（create / keepalive）

挂载 VideoRoom 插件（attach）

以订阅者身份加入直播房间（VideoRoom join）

应答 SDP 并启动媒体（VideoRoom start）

交换 ICE 候选（VideoRoom trickle）

离开直播房间（VideoRoom leave）

查询直播订阅人数（Admin handle_info）

批量查询设备类别信息（list-category-info）

代报设备类别信息（report-category-info）

直播链路获取 ICE 服务器（list-ice-server）

直播链路批量查询在线状态（list-online-status）

回放与文件

按采集服务器批量查询文件分类总数（list-file-category-total）

查询文件按日存在性（list-file-existence）

拉取当日文件清单（list-file-info）

回放媒体播放与下载地址（动态媒体 URL）

加密文件解密取播放地址（data/v1/decrypt）

拉取回放文件 GPS 轨迹（data/v1/gps）

设备远控

读取设备配置（get-configs）

修改设备配置（set-configs）

发送设备 BC+ 原始指令（bcplus）

触发设备固件与文件上报（retrieve）

下发 ICE 服务器到设备（webrtc deliver）

采集服务器远控

读取采集服务器概要（serverinfo）

读取磁盘信息（server data disk）

读取服务列表（server data service）

读取系统配置（server data sysconfig）

启用/禁用磁盘分区（server data partition）

重启服务（server data service-restart）

更新系统配置（server data sysconfig-update）

触发磁盘服务刷新（server data refresh_service）

触发采集服务器固件信息下发（server retrieve）

日志与报表

枚举日志检索索引

读取日志索引设置

更新日志索引设置

跨分区日志检索

Dashboard

配置与翻译

配置字典与值集字段模型

查询数据字典列表

读取数据字典缓存列表（业务租户+default 合并）

分页查询数据字典

按 ID 查询数据字典详情

新增数据字典

修改数据字典

删除数据字典

批量删除数据字典

异步导入数据字典列表（JMS 发布受理）

查询数据字典类型列表

读取数据字典类型缓存列表（业务租户+default 合并）

分页查询数据字典类型

按 ID 查询数据字典类型详情

新增数据字典类型

修改数据字典类型

删除数据字典类型

批量删除数据字典类型

查询数据字典映射列表

分页查询数据字典映射

按 ID 查询数据字典映射详情

新增数据字典映射

修改数据字典映射

删除数据字典映射

批量删除数据字典映射

查询数据字典表列表

分页查询数据字典表

按 ID 查询数据字典表详情

新增数据字典表

修改数据字典表

删除数据字典表

批量删除数据字典表

查询值集列表

分页查询值集

按 ID 查询值集详情

批量删除值集

查询值集类型列表

分页查询值集类型

按 ID 查询值集类型详情

新增值集类型

修改值集类型

删除值集类型

批量删除值集类型

查询值集映射列表

分页查询值集映射

按 ID 查询值集映射详情

新增值集映射

修改值集映射

删除值集映射

批量删除值集映射

查询值集表列表

分页查询值集表

按 ID 查询值集表详情

新增值集表

修改值集表

删除值集表

批量删除值集表

查询翻译列表

分页查询翻译

按 ID 读取翻译

新增翻译词条

上报缺失翻译

修改翻译词条

删除单条翻译

批量删除翻译

批量导入翻译

运维

读取 Agent 服务器时间

查询数据库备份列表

触发数据库备份

下载数据库备份

按设备与类型列出设备文件

下载设备文件

地图与公共资源

地图底图瓦片源

逆地理编码（坐标转地址）

共享与其他

MQTT 连接与用户会话订阅

读取当前用户基础信息

修改个人基础信息

修改登录密码

上传用户头像

查询设备型号列表

查询设备类型树

枚举文件存储设备号

查询云服务节点信息（getCloudServiceInfo）

App 场景流程

登录与切换空间

实时监看与直播

回放与文件下载

对讲群组与房间

覆盖与缺口

页面与操作双向索引

未发布正本与保留项

零售

设备

数据采集设备

设备共享

数据采集设备

过滤

数据采集设备

列表

请求路径
请求结构 (Api request)
响应结构 (Api response)

添加共享

请求路径
请求结构 (Api request)
响应结构 (Api response)