GB28181 APIs
This layer covers GB28181 registration, catalog, live view, playback, PTZ, talkback, alarms, and cascading. SIP commands are asynchronous: accepted does not mean the device has completed the action.
This page covers 55 operations. Each row states the endpoint, purpose, timing, completion check, and caller identity. Use the matching OpenAPI file for exact field schemas.
Business APIs may be called by the WebUI or an authorized integration. Administrator APIs require an admin session. Internal APIs and callbacks are only for trusted product components.
GB28181 国标
| Endpoint | Plain meaning | When to use it | How to confirm | Audience / permission | Main input |
|---|---|---|---|---|---|
GET /api/v2/gb28181/alarms/events |
Read gb28181 / alarms / events. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
deviceId, channelId, alarmPriority, alarmMethod, alarmType, ackStatus, begin, end, page, pageSize |
POST /api/v2/gb28181/alarms/query |
Create or run gb28181 / alarms / query. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181AlarmQueryRequest |
POST /api/v2/gb28181/alarms/report |
Create or run gb28181 / alarms / report. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181AlarmReportRequest |
POST /api/v2/gb28181/alarms/reset |
Create or run gb28181 / alarms / reset. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181AlarmResetRequest |
POST /api/v2/gb28181/broadcast |
Create or run gb28181 / broadcast. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181BroadcastRequest |
POST /api/v2/gb28181/catalog/items |
Create or run gb28181 / catalog / items. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181CatalogItemRequest |
POST /api/v2/gb28181/catalog/query |
Create or run gb28181 / catalog / query. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181CatalogQueryRequest |
GET /api/v2/gb28181/catalog/query/{taskId} |
Read gb28181 / catalog / query / the selected taskId. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
taskId (required), pageSize |
GET /api/v2/gb28181/client/platform |
Read gb28181 / client / platform. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
deviceId |
GET /api/v2/gb28181/commands |
Read gb28181 / commands. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
status, commandType, page, pageSize |
POST /api/v2/gb28181/device-config/query |
Create or run gb28181 / device config / query. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181DeviceConfigQueryRequest |
POST /api/v2/gb28181/device-config/set |
Create or run gb28181 / device config / set. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181DeviceConfigSetRequest |
POST /api/v2/gb28181/device-control/drag-zoom |
Create or run gb28181 / device control / drag zoom. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181DragZoomRequest |
POST /api/v2/gb28181/device-control/guard |
Create or run gb28181 / device control / guard. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181GuardControlRequest |
POST /api/v2/gb28181/device-control/home-position |
Create or run gb28181 / device control / home position. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181HomePositionRequest |
POST /api/v2/gb28181/device-control/iframe |
Create or run gb28181 / device control / iframe. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181IFrameRequest |
POST /api/v2/gb28181/device-control/record |
Create or run gb28181 / device control / record. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181RecordControlRequest |
POST /api/v2/gb28181/device-control/results |
Create or run gb28181 / device control / results. | Used automatically between trusted product components; third-party applications must not call it. | Read the target resource again and verify both saved and runtime state. | Internal callback<br>devices.control |
Gb28181DeviceControlReportRequest |
POST /api/v2/gb28181/device-control/teleboot |
Create or run gb28181 / device control / teleboot. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181TeleBootRequest |
POST /api/v2/gb28181/device-info/query |
Create or run gb28181 / device info / query. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181DeviceInfoQueryRequest |
POST /api/v2/gb28181/device-status/query |
Create or run gb28181 / device status / query. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181DeviceStatusQueryRequest |
POST /api/v2/gb28181/devices/{deviceId}/unregister |
Create or run gb28181 / devices / the selected deviceId / unregister. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.manage |
deviceId (required) |
POST /api/v2/gb28181/devices/keepalive |
Create or run gb28181 / devices / keepalive. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.manage |
Gb28181KeepaliveRequest |
POST /api/v2/gb28181/devices/register |
Create or run gb28181 / devices / register. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.manage |
Gb28181RegisterRequest |
POST /api/v2/gb28181/devices/timeout-scan |
Create or run gb28181 / devices / timeout scan. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.manage |
No business input |
GET /api/v2/gb28181/live/{deviceId}/{channelId} |
Read gb28181 / live / the selected deviceId / the selected channelId. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
deviceId (required), channelId (required) |
POST /api/v2/gb28181/live/invite |
Create or run gb28181 / live / invite. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181InviteLiveRequest |
POST /api/v2/gb28181/live/stop |
Create or run gb28181 / live / stop. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>devices.control |
Gb28181StopLiveRequest |
POST /api/v2/gb28181/media-status/report |
Create or run gb28181 / media status / report. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181MediaStatusReportRequest |
GET /api/v2/gb28181/mobile-position/events |
Read gb28181 / mobile position / events. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
DeviceId, DeviceChannelId, VideoChannelId, Begin (required), End (required), MinLongitude, MaxLongitude, MinLatitude, MaxLatitude, Page (required), PageSize (required) |
DELETE /api/v2/gb28181/mobile-position/events/{id} |
Delete gb28181 / mobile position / events / the selected id. | Use it only after the user has reviewed and confirmed the affected data. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.manage |
id (required), positionTime, reason (required) |
GET /api/v2/gb28181/mobile-position/map-config |
Read gb28181 / mobile position / map config. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
No business input |
POST /api/v2/gb28181/mobile-position/query |
Create or run gb28181 / mobile position / query. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181MobilePositionQueryRequest |
GET /api/v2/gb28181/mobile-position/status |
Read gb28181 / mobile position / status. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
No business input |
POST /api/v2/gb28181/playback/invite |
Create or run gb28181 / playback / invite. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181InvitePlaybackRequest |
POST /api/v2/gb28181/playback/pause |
Create or run gb28181 / playback / pause. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181PlaybackControlRequest |
POST /api/v2/gb28181/playback/resume |
Create or run gb28181 / playback / resume. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181PlaybackControlRequest |
POST /api/v2/gb28181/playback/seek |
Create or run gb28181 / playback / seek. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181PlaybackSeekRequest |
POST /api/v2/gb28181/playback/speed |
Create or run gb28181 / playback / speed. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181PlaybackControlRequest |
POST /api/v2/gb28181/playback/stop |
Create or run gb28181 / playback / stop. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>devices.control |
Gb28181StopPlaybackRequest |
GET /api/v2/gb28181/presets |
Read gb28181 / presets. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
deviceId (required), channelId |
POST /api/v2/gb28181/presets/control |
Create or run gb28181 / presets / control. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181PresetControlRequest |
POST /api/v2/gb28181/presets/query |
Create or run gb28181 / presets / query. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181PresetQueryRequest |
POST /api/v2/gb28181/ptz |
Create or run gb28181 / ptz. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181PtzRequest |
POST /api/v2/gb28181/records/query |
Create or run gb28181 / records / query. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181QueryRecordFileRequest |
GET /api/v2/gb28181/records/query/{taskId} |
Read gb28181 / records / query / the selected taskId. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
taskId (required) |
GET /api/v2/gb28181/sessions |
Read gb28181 / sessions. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
deviceId, channelId, state, sessionType, page, pageSize |
GET /api/v2/gb28181/signals |
Read gb28181 / signals. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
eventType, deviceId, channelId, status, begin, end, page, pageSize |
GET /api/v2/gb28181/state-model |
Read gb28181 / state model. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
No business input |
GET /api/v2/gb28181/subscriptions |
Read gb28181 / subscriptions. | Use it when loading a page, refreshing state, or searching current data. | Use the returned data, paging totals, and current resource state. | Business API<br>devices.view |
subscriptionType, deviceId, channelId, status, page, pageSize |
POST /api/v2/gb28181/subscriptions/cancel |
Create or run gb28181 / subscriptions / cancel. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181SubscribeRequest |
POST /api/v2/gb28181/subscriptions/renew-due |
Create or run gb28181 / subscriptions / renew due. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
maxCount |
POST /api/v2/gb28181/subscriptions/subscribe |
Create or run gb28181 / subscriptions / subscribe. | Use it when the user submits this action or configuration change. | Read the target resource again and verify both saved and runtime state. | Business API<br>devices.control |
Gb28181SubscribeRequest |
Unified talkback
| Endpoint | Plain meaning | When to use it | How to confirm | Audience / permission | Main input |
|---|---|---|---|---|---|
POST /api/v2/gb28181/talk/start |
Create or run gb28181 / talk / start. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>devices.talk |
Gb28181StartTalkRequest |
POST /api/v2/gb28181/talk/stop |
Create or run gb28181 / talk / stop. | Use it when the user submits this action or configuration change. | An HTTP success means accepted; poll or subscribe until the resource reaches a final state. | Business API<br>devices.talk |
Gb28181StopTalkRequest |
Fields and examples
This page keeps business purpose readable. When coding, use the OpenAPI and Postman assets shipped with the deployed version for request bodies, response bodies, enums, file types, and examples. Do not use a newer website contract against an older service.