- Root directory
- Root directory
- Authentication
- User
- Role
- User Management
- Create user group
- Modify user group
- Delete user group
- User information retrieval request
- Check whether the created user information is available.
- Create user
- Modify user
- Delete user
- Change user password
- Kick the user offline
- Get the list of user resources
- Add user resource
- Delete user resources
- Bind user device
- Unbind user device
- device
- Get root device group information
- Get the device group list
- Get device group information
- Get the device category list
- Get device classification information
- Get the device list
- Get device information
- Get the online status of the device
- Get the device's current location
- Get battery information
- Pass-through command
- Manual Recording - Start
- Manual Recording - Stop
- Manually capture a picture
- Device Management
- Create a device group
- Modify device group
- Delete device group
- Add device
- Delete device
- Restart the device
- Turn off the device
- Create device category
- Modify device category
- Delete device category
- Get ungrouped device information
- Modify the device's basic information
- Batch modify the group to which the device belongs
- Batch modify the category to which the device belongs
- Modify device channel information
- Kick the online device offline
- Get general configuration
- Set general configuration
- Set power configuration
- Get Ethernet configuration
- Set up Ethernet configuration
- Get Wifi configuration
- Set up Wi-Fi configuration
- Get wireless network configuration
- Set up wireless network configuration
- Get capture configuration
- Set up capture configuration
- Get audio input configuration
- Set audio input configuration
- Get audio output configuration
- Set audio output configuration
- Get device encoding channel attributes
- Set device encoding channel attributes
- Get video source
- Set video source
- Get device GPS configuration
- Set device GPS configuration
- Get device server configuration
- Set device server configuration
- Get device storage information
- Set device storage information
- Get formatting progress
- Format the memory
- Get device storage settings
- Modify device storage settings
- Get device upload settings
- Modify device upload settings
- Get storage status
- Get storage plan
- Set up a storage plan
- Get overlay information
- Set overlay information
- Get firmware upgrade status
- Batch get firmware upgrade status
- Firmware upgrade
- Get law enforcement device information
- Set law enforcement device information
- Get sensor data
- Set sensor data
- Get online and offline control configuration
- Set up online and offline control configuration
- Add configuration plan
- Modify the configuration plan
- Delete configuration plan
- Get configuration plan
- Get the configuration plan list
- Add configuration plan device
- Delete the configuration plan device
- Get the list of configured device.
- Get the configuration plan device
- Get the list of devices not associated with the configuration plan
- Get device language
- Change device language
- Get alarm input configuration
- Set alarm input configuration
- Gimbal
- Pan-Tilt Lens Control
- Get the list of gimbal presets
- Add gimbal preset point
- Modify the pan-tilt preset point
- Delete Pan-Tilt Preset Point Operation
- Go to the PTZ preset point
- Get the list of gimbal cruise routes
- Add gimbal cruise route
- Start the pan-tilt cruise route.
- Stop the gimbal cruise route
- Delete the gimbal cruise route
- IM group
- Get group list
- Get the group member list
- Get group member information
- Get group information
- Create group
- Edit group
- Delete group
- Add group members
- Delete group members
- Modify other group members
- Modify your group nickname
- Transfer Group
- create a meeting
- revision meeting
- delete conference
- Get meeting information
- Get a list of meeting members
- Get meeting member information
- Get the default meeting member list
- Join the meeting yourself
- Quit the meeting yourself
- floor requesting
- concluding
- Invite others to join the meeting
- Kick people out of meetings
- Name others to speak
- Get default meeting
- Add default meeting
- Delete default meeting
- Conference recording control
- gag control
- instant messaging
- websocket
- historical data
- Platform document retrieval
- Obtain video file information
- Modify video file information
- handle alarm
- alarm records
- Delete alarm records in batches
- Device GPS trajectory
- Device File Retrieval
- Download device files
- Delete device files
- Device offline log
- User offline log
- Device offline log (extend)
- User offline log (extend)
- operation log
- channel log
- System alarm record
- Basic data statistics
- Channel log statistics
- Offline data statistics
- electronic fence
- alarm linkage
- 28181in
- Get a list of 28181 devices
- Get 28181 device information
- Add 28181 equipment
- Modification of 28181 Equipment
- Remove 28181 equipment
- Get a list of 28181 platforms
- Get 28181 platform information
- Add 28181 platform
- Modify the 28181 platform
- Delete the 28181 platform
- Get the 28181 platform grouping list
- obtain configuration information
- Create a video file download task
- Get a list of video files
- Get video file download progress
- Video file download
- Update channel information
- Push the 28181 platform organization structure to 28181 output
- Create server certificate request
- Get a list of server certificates
- Get server certificate information
- Modify server certificate information
- Delete server certificate
- self-signed server certificate
- Upload device certificate request
- Get a list of device certificate requests
- issue certificates
- Modify certificate request information
- Get device certificate request information
- Delete device certificate request information
- Add national secret equipment information
- Get a list of national secret devices
- Modify national secret equipment information
- Delete national secret equipment information
- Obtain national secret equipment information
- 28181out
- Add superior platform
- Obtain superior platform information
- Modify the superior platform
- Delete superior platform
- Get a list of superior platforms
- push list
- acquisition state
- Get a list of device groups
- Add device grouping
- Modify device grouping
- Delete device grouping
- Get device groups
- Get a list of 28181 devices
- Get a list of unadded devices
- Add 28181 equipment
- Add 28181 equipment in batches
- Modification of 28181 Equipment
- Remove 28181 equipment
- Obtaining 28181 device information based on puid
- Obtaining 28181 device information based on national standard id
- Add channel information
- Modify channel information
- Delete channel information
- Get channel information
- Get a list of 28181 channels
- Add superior platform equipment
- Delete superior platform equipment
- Get a list of superior platform devices
- map label
- Create map point labels
- Modify map point labels
- Query the map point label list
- Query map point label information
- Create map line labels
- Modify map line labels
- Query the map line label list
- Query map line label information
- Create map surface labels
- Modify map surface labels
- Query the map tab list
- Query map label information
- Add map label anchor points
- Modify map label anchor points
- Delete map label anchor points
- Delete map tags
- Query the map label anchor point list
- Query map label positioning point information
- Video file timeline
- platform storage
- Download Plan--Add
- Download Plan-Get
- Download Plan-Modify
- Download Plan--Query
- Download Plan-Delete
- Video Plan-Add
- Video Plan-Get
- Video Plan--Modify
- Video Plan-Query
- Video Plan-Delete
- Plan Device Association--Add
- Plan Equipment Association-Modify
- Plan Equipment Association-Delete
- Planning Equipment Association--Query
- Planned equipment association--query is not associated
- Manual recording-start
- Manual recording-End
- Grab a picture manually
- Platform storage status
- contact
- module program
- black and white list
- media streaming operation
- close the session
- Open the device's audio and video stream webrtc
- Open the device audio and video stream bvrtc
- Open the voice conference stream webrtc
- Open the voice conference stream bvrtc
- Open the voice conference stream websocket
- Open playback of audio and video streams
- playback control
- View the conversation list
- Get session information
- View the list of streaming services
- Reset streaming service statistics
- Push audio and video streaming webrtc
- Collection station management
- Acquisition station docking
- Platform document classification
- Schemas
- Root directory
- root directory
- user
- device
- Ethernet configuration
- wifi_config
- snapshot_config
- gps_config
- pu_zfy_info
- pu_sensor_data
- language_info
- pu_online_control
- station_info
- pu_cruise_info
- pu_overlay_config
- pu_storage_schedule
- pu_storage_rule
- storages_config
- Device server configuration
- encoder_config
- audioin_config
- radio_config
- battery information
- pu_info
- group information
- channel
- uploadConfig
- map
- alarm
- 28181
Instant messaging subscription
GET
https://192.168.88.11:9781/bvcsp/v1/ws/im
Last modified:2026-01-04 06:12:28
The upstream data of this connection is sent messages, and the downstream data is information distributed by the server.
By default, the connection will be closed if there is no data transmission for 1 minute. The subscriber can send an empty message every 20 seconds to maintain the connection!!!
var ws = new WebSocket("ws://localhost/bvcsp/v1/ws/im",[token]);var upgrader = websocket.Upgrader{
Subprotocols: []string{r.Header.Get("Sec-WebSocket-Protocol")},
}text,custom: {textMsg:"xxxx"}
file,picture,audio,video,confaudio: {fileID:"xxx",fileSize:"121212",fileName:"xxx.jpg",duration:10000};duration indicates the duration of the audio and video file, in milliseconds
GPS: Same as querying the GPS objects in the GPS data interface {lat: 31.54512, lng: 117.54545, height:6521,angle:2154,speed:212,startCount:3}; the units are: degrees, degrees, centimeters, 1/1000 degrees, meters/hour, and pieces.
system: System message
{
"operate":"operate",
"member":{"member_type":"member type", "member_id":"", "member_name":"member name"},
"conf":{"conf_id":"conference id"}
}
The operation type is as follows
"add_member": Add member, load member
"del_member": Delete member, load member
"start_conf": Start the meeting, load conf
"stop_conf": Stop the meeting, load confRequest
Query Params
Header Params
Body Params application/json
Example
{
"audience": "string",
"audienceType": "User",
"msgType": "text",
"msgContent": "string"
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://192.168.88.11:9781/bvcsp/v1/ws/im?token=xxxxxx' \
--header 'Sec-WebSocket-Protocol: string' \
--header 'Content-Type: application/json' \
--data-raw '{
"audience": "string",
"audienceType": "User",
"msgType": "text",
"msgContent": "string"
}'Responses
🟢200successful
application/json
Body
Example
{
"id": 0,
"speaker": "string",
"speakerType": "User",
"speakerName": "string",
"audience": "string",
"audienceType": "User",
"time": 0,
"msgType": "text",
"msgContent": "string"
}Modified at 2026-01-04 06:12:28