GB28181 接口
这一层处理国标设备注册、目录、点播、回放、PTZ、对讲、告警和级联。SIP 请求经常需要等设备异步回应，所以“命令已发送”不等于“设备已执行”。
本页覆盖 55 个接口。每一行都回答五件事：接口地址、它做什么、何时调用、如何确认完成、谁可以调用。参数字段的精确定义以同版本 OpenAPI 为准。
“业务接口”可以由 WebUI 或第三方系统按权限调用；“管理员接口”需要后台管理员；“内部接口/内部回调”只允许产品组件之间使用。
GB28181 国标
| 接口 | 讲人话 | 什么时候用 | 调完看什么 | 身份 / 权限 | 主要输入 |
|---|---|---|---|---|---|
GET /api/v2/gb28181/alarms/events |
查询 GB28181 告警事件。 | 页面加载、刷新状态或按条件检索数据时调用。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
deviceId、channelId、alarmPriority、alarmMethod、alarmType、ackStatus、begin、end、page、pageSize |
POST /api/v2/gb28181/alarms/query |
创建 GB28181 告警查询命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181AlarmQueryRequest |
POST /api/v2/gb28181/alarms/report |
协议网关回写 GB28181 告警事件。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181AlarmReportRequest |
POST /api/v2/gb28181/alarms/reset |
创建 GB28181 报警复位控制命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181AlarmResetRequest |
POST /api/v2/gb28181/broadcast |
创建 GB28181 语音广播命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181BroadcastRequest |
POST /api/v2/gb28181/catalog/items |
GB28181 目录通道上报。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181CatalogItemRequest |
POST /api/v2/gb28181/catalog/query |
创建 GB28181 主动目录查询命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181CatalogQueryRequest |
GET /api/v2/gb28181/catalog/query/{taskId} |
查询 GB28181 主动目录查询任务状态。 | 页面加载、刷新状态或按条件检索数据时调用。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
taskId（必填）、pageSize |
GET /api/v2/gb28181/client/platform |
查询 GB28181 Client 侧上级平台注册状态。 | 页面加载、刷新状态或按条件检索数据时调用。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
deviceId |
GET /api/v2/gb28181/commands |
查询 GB28181 协议命令。 | 页面加载、刷新状态或按条件检索数据时调用。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
status、commandType、page、pageSize |
POST /api/v2/gb28181/device-config/query |
创建 GB28181 设备配置查询命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181DeviceConfigQueryRequest |
POST /api/v2/gb28181/device-config/set |
创建 GB28181 设备配置设置命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181DeviceConfigSetRequest |
POST /api/v2/gb28181/device-control/drag-zoom |
创建 GB28181 拉框放大或缩小控制命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181DragZoomRequest |
POST /api/v2/gb28181/device-control/guard |
创建 GB28181 布防或撤防控制命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181GuardControlRequest |
POST /api/v2/gb28181/device-control/home-position |
创建 GB28181 看守位控制命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181HomePositionRequest |
POST /api/v2/gb28181/device-control/iframe |
创建 GB28181 强制关键帧控制命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181IFrameRequest |
POST /api/v2/gb28181/device-control/record |
创建 GB28181 录像控制命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181RecordControlRequest |
POST /api/v2/gb28181/device-control/results |
回填 GB28181 DeviceControl 业务响应。 | 这是组件之间自动通信的入口，第三方业务系统不要主动调用。 | 由调用方与服务端身份校验、回执和关联命令状态共同确认。 | 内部回调<br>devices.control |
Gb28181DeviceControlReportRequest |
POST /api/v2/gb28181/device-control/teleboot |
创建 GB28181 远程启动控制命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181TeleBootRequest |
POST /api/v2/gb28181/device-info/query |
创建 GB28181 设备信息查询命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181DeviceInfoQueryRequest |
POST /api/v2/gb28181/device-status/query |
创建 GB28181 设备状态查询命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181DeviceStatusQueryRequest |
POST /api/v2/gb28181/devices/{deviceId}/unregister |
GB28181 设备注销上报。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.manage |
deviceId（必填） |
POST /api/v2/gb28181/devices/keepalive |
GB28181 设备心跳上报。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.manage |
Gb28181KeepaliveRequest |
POST /api/v2/gb28181/devices/register |
GB28181 设备注册上报。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.manage |
Gb28181RegisterRequest |
POST /api/v2/gb28181/devices/timeout-scan |
手工触发 GB28181 Server 下级设备心跳超时扫描。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.manage |
无业务参数 |
GET /api/v2/gb28181/live/{deviceId}/{channelId} |
查询 GB28181 实时流会话。 | 页面加载、刷新状态或按条件检索数据时调用。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
deviceId（必填）、channelId（必填） |
POST /api/v2/gb28181/live/invite |
请求 GB28181 实时流。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181InviteLiveRequest |
POST /api/v2/gb28181/live/stop |
停止 GB28181 实时流。 | 用户提交业务动作或配置变更时调用。 | HTTP 成功只表示请求被接收；继续查询命令、任务、通道或会话状态，直到成功或失败终态。 | 业务接口<br>devices.control |
Gb28181StopLiveRequest |
POST /api/v2/gb28181/media-status/report |
处理 GB28181 MediaStatus 历史媒体结束通知。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181MediaStatusReportRequest |
GET /api/v2/gb28181/mobile-position/events |
跨天查询 GB28181 GPS 历史轨迹。 | 页面加载、刷新状态或按条件检索数据时调用。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
DeviceId、DeviceChannelId、VideoChannelId、Begin（必填）、End（必填）、MinLongitude、MaxLongitude、MinLatitude、MaxLatitude、Page（必填）、PageSize（必填） |
DELETE /api/v2/gb28181/mobile-position/events/{id} |
逻辑删除一条 GB28181 GPS 轨迹。 | 用户明确确认删除或清理后调用；调用前应先展示影响范围。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.manage |
id（必填）、positionTime、reason（必填） |
GET /api/v2/gb28181/mobile-position/map-config |
查看GPS 轨迹地图前端配置。 | 页面加载、刷新状态或按条件检索数据时调用。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
无业务参数 |
POST /api/v2/gb28181/mobile-position/query |
创建 GB28181 移动位置查询命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181MobilePositionQueryRequest |
GET /api/v2/gb28181/mobile-position/status |
查询 GPS 轨迹 Provider 运行状态。 | 做页面概览、运行监控或排障时调用。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
无业务参数 |
POST /api/v2/gb28181/playback/invite |
请求 GB28181 历史回放流。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181InvitePlaybackRequest |
POST /api/v2/gb28181/playback/pause |
暂停 GB28181 历史回放。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181PlaybackControlRequest |
POST /api/v2/gb28181/playback/resume |
继续 GB28181 历史回放。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181PlaybackControlRequest |
POST /api/v2/gb28181/playback/seek |
执行 GB28181 历史回放定位。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181PlaybackSeekRequest |
POST /api/v2/gb28181/playback/speed |
调整 GB28181 历史回放倍速。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181PlaybackControlRequest |
POST /api/v2/gb28181/playback/stop |
停止 GB28181 历史回放流。 | 用户提交业务动作或配置变更时调用。 | HTTP 成功只表示请求被接收；继续查询命令、任务、通道或会话状态，直到成功或失败终态。 | 业务接口<br>devices.control |
Gb28181StopPlaybackRequest |
GET /api/v2/gb28181/presets |
查看最近一次 GB28181 预置位查询缓存结果。 | 页面加载、刷新状态或按条件检索数据时调用。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
deviceId（必填）、channelId |
POST /api/v2/gb28181/presets/control |
创建 GB28181 预置位设置、调用或删除控制命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181PresetControlRequest |
POST /api/v2/gb28181/presets/query |
创建 GB28181 预置位查询命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181PresetQueryRequest |
POST /api/v2/gb28181/ptz |
创建 GB28181 云台动作 控制命令。 | 用户提交业务动作或配置变更时调用。 | HTTP 成功只表示请求被接收；继续查询命令、任务、通道或会话状态，直到成功或失败终态。 | 业务接口<br>devices.control |
Gb28181PtzRequest |
POST /api/v2/gb28181/records/query |
创建 GB28181 设备历史录像查询命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181QueryRecordFileRequest |
GET /api/v2/gb28181/records/query/{taskId} |
查询 GB28181 设备历史录像查询任务状态。 | 页面加载、刷新状态或按条件检索数据时调用。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
taskId（必填） |
GET /api/v2/gb28181/sessions |
查询 GB28181 流会话。 | 页面加载、刷新状态或按条件检索数据时调用。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
deviceId、channelId、state、sessionType、page、pageSize |
GET /api/v2/gb28181/signals |
查询 GB28181 信令事件。 | 页面加载、刷新状态或按条件检索数据时调用。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
eventType、deviceId、channelId、status、begin、end、page、pageSize |
GET /api/v2/gb28181/state-model |
查看GB28181 状态机说明。 | 在展示功能、生成表单或发起控制前，先用它确认当前版本和目标设备真正支持什么。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
无业务参数 |
GET /api/v2/gb28181/subscriptions |
分页查询 GB28181 订阅状态。 | 页面加载、刷新状态或按条件检索数据时调用。 | 以返回数据、分页总数和目标资源的当前状态为准。 | 业务接口<br>devices.view |
subscriptionType、deviceId、channelId、status、page、pageSize |
POST /api/v2/gb28181/subscriptions/cancel |
取消 GB28181 协议订阅。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181SubscribeRequest |
POST /api/v2/gb28181/subscriptions/renew-due |
手动触发 GB28181 到期订阅续期扫描。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
maxCount |
POST /api/v2/gb28181/subscriptions/subscribe |
创建 GB28181 目录、告警或移动位置订阅命令。 | 用户提交业务动作或配置变更时调用。 | 重新读取目标资源，确认保存值和运行状态都已更新。 | 业务接口<br>devices.control |
Gb28181SubscribeRequest |
统一对讲
| 接口 | 讲人话 | 什么时候用 | 调完看什么 | 身份 / 权限 | 主要输入 |
|---|---|---|---|---|---|
POST /api/v2/gb28181/talk/start |
启动 GB28181 双向语音对讲。 | 用户提交业务动作或配置变更时调用。 | HTTP 成功只表示请求被接收；继续查询命令、任务、通道或会话状态，直到成功或失败终态。 | 业务接口<br>devices.talk |
Gb28181StartTalkRequest |
POST /api/v2/gb28181/talk/stop |
停止 GB28181 双向语音对讲。 | 用户提交业务动作或配置变更时调用。 | HTTP 成功只表示请求被接收；继续查询命令、任务、通道或会话状态，直到成功或失败终态。 | 业务接口<br>devices.talk |
Gb28181StopTalkRequest |
接口字段与示例
本页故意先讲清业务用途，不把几百个字段塞进说明文字。真正编码时，请使用与部署版本一起提供的 OpenAPI 和 Postman 资产查看请求体、响应体、枚举、文件类型与示例；不要拿网站最新契约调用旧版本服务。