en-bvcsp
  1. websocket
en-bvcsp
  • Root directory
    • Root directory
      • Certification
        • User Login
        • Log out
        • Refresh token
        • Get the current logged in user information
        • Modify the current user password
        • Get the device login QR code
      • User
        • Get root user group information
        • Get user group information
        • Get the list of user groups
        • Get user list
        • Get the list of online users
        • Get user online status
        • Get the current location of the user
        • Get user information
      • Role
        • Get the list of roles
        • Get Role Information
        • Create a role
        • Modify Role
        • Delete Role
        • Get the list of role resources
        • Add Role Resources
        • Delete Role Resources
      • User Management
        • Create a user group
        • Modify User Group
        • Delete User Group
        • Requirements for getting user information
        • Check if the user information created is available
        • Create a user
        • Modify user
        • Delete user
        • Modify user password
        • Kick user offline
        • Get user resource list
        • Add user resources
        • Delete user resources
      • device
        • Get root device group information
        • Get device group list
        • Get device group information
        • Get device classification list
        • Get device classification information
        • Get device list
        • Get device information
        • Get device online status
        • Get the current location of the device
        • Get battery information
        • Transparent command
        • Manual recording - Start
        • Manual recording - Stop
        • Take a picture with the device
      • Device Management
        • Create a device group
        • Modify device group
        • Delete Device Group
        • Add a device
        • Delete device
        • Restart the device
        • Create a device category
        • Modify device classification
        • Delete device category
        • Get ungrouped device information
        • Modify device basic information
        • Modify device channel information
        • Kick offline the device online
        • Get the common configuration
        • Set up the common configuration
        • Set up power configuration
        • Get Ethernet configuration
        • Set up Ethernet configuration
        • Get Wifi configuration
        • Set up the Wifi configuration
        • Get wireless network configuration
        • Set up wireless network configuration
        • Get the snap configuration
        • Set up the capture configuration
        • Get audio input configuration
        • Set up audio input configuration
        • Get audio output configuration
        • Set the audio output configuration
        • Get device code channel properties
        • Set device encoding channel properties
        • Get the video source
        • Set the video source
        • Get device GPS configuration
        • Set the GPS configuration of the device
        • Get device server configuration
        • Set up device server configuration
        • Get device memory information
        • Set device memory information
        • Get formatting progress
        • Format the device
        • Get device storage settings
        • Modify device storage settings
        • Get device upload settings
        • Modify device upload settings
        • Get storage status
        • Get storage plan
        • Set up storage plans
        • Get overlay information
        • Set the overlay information
        • Get upgrade firmware status
        • Upgrade the firmware
        • Get the information of the law enforcement device
        • Set up the information of the law enforcement device
        • Get sensor data
        • Set sensor data
        • Get the upper and lower limit control configuration
        • Set the upper and lower limit control configuration
        • Add a configuration plan
        • Modify the configuration plan
        • Delete the configuration plan
        • Get the configuration plan
        • Get the list of configuration plans
        • Add a configuration plan device
        • Delete the configuration plan device
        • Get the configuration plan device list
        • Get the configuration plan device
        • Get the list of devices not associated with a configuration plan
      • The gimbal
        • Pan/Tilt lens control
        • Get the list of preset positions for the pan/tilt
        • Add a preset to the pan/tilt
        • Modify the preset positions of the pan/tilt
        • Delete the pan/tilt preset operation
        • Go to the preset position of the pan/tilt
        • Get the list of pan and tilt routes
        • Add a pan and tilt route
        • Start the pan-tilt cruise route
        • Stop the pan and tilt route
        • Delete the pan and tilt route
      • IM group
        • Get the list of groups
        • Get the list of group members
        • Get group member information
        • Get group information
        • Create a group
        • Modify the group
        • Delete group
        • Add group members
        • Remove group members
        • Modify other group members
        • Modify your group nickname
        • Transfer group
        • Create a meeting
        • Modify the meeting
        • Delete the meeting
        • Get meeting information
        • Get the list of meeting members
        • Get meeting member information
        • Join the meeting yourself
        • Exit the meeting by yourself
        • Application for speaking
        • End of speech
        • Invite others to join the meeting
        • Kick someone out of a meeting
        • Call on others to speak
        • Get default meeting
        • Add default meeting
        • Delete default meeting
        • Meeting Recording Control
        • Mute control
      • Instant messaging
        • Send a communication message
        • Confirm that the message has been read
        • Query my chat records
        • Chat History Advanced Query
        • Query the read message ID
        • Request audio and video call
      • websocket
        • Online Status Subscription
          GET
        • Alarm Event Subscription
          GET
        • Instant Messaging Subscription
          GET
        • Device Location Subscription
          GET
        • Meeting Event Subscription
          GET
        • Command Interact Subscription
          GET
      • Historical data
        • Platform file retrieval
        • Get video file information
        • Modify the video file information
        • Handle the alarm
        • Alarm records
        • Device GPS trajectory
        • Device file retrieval
        • Download device files
        • Delete device file
        • Device Online/Offline Log
        • User Online/Offline Log
        • Device Online/Offline Log (extend)
        • User Online/Offline Log (extend)
        • Operation Log
        • Channel Log
        • System alarm records
        • Create a statistical task
        • Get the statistics result
        • Delete the statistical task
      • Electronic fence
        • Get the list of fences
        • Get the fence information
        • Create a platform fence
        • Modify the platform fence
        • Delete the platform fence
        • Get the list of fence devices
        • Add Fence Device
        • Delete Fence Device
      • Alarm linkage
        • Add alarm linkage
        • Modify alarm linkage
        • Get the alarm linkage list
        • Get alarm linkage
        • Delete alarm linkage
        • Add Alarm Linkage Object List
        • Delete the alarm linkage target
        • Get the list of alarm linkage objects
        • Add Alarm Link Action
        • Delete alarm linkage action
        • Get the alarm linkage action list
        • Get alarm linkage action
      • 28181in
        • Get 28181 device list
        • Get 28181 device information
        • Add 28181 device
        • Modify device 28181
        • Delete device 28181
        • Get the list of 28181 devices
        • Get the information of 28181 platform
        • Add 28181 platform
        • Modify the 28181 platform
        • Delete the 28181 platform
        • Get the list of 28181 platform groups
        • Get configuration information
        • Create a video file download task
        • Get the list of video files
        • Get the progress of video file download
        • Video file download
        • Update channel information
      • 28181out
        • Add a parent platform
        • Get the information of the upper platform
        • Modify the parent platform
        • Delete the parent platform
        • Push Catalog
        • Get the list of parent platforms
        • Get status
        • Get device group list
        • Add device group
        • Modify device group
        • Delete device group
        • Get device groups
        • Get 28181 device list
        • Add 28181 device
        • Modify device 28181
        • Delete device 28181
        • Get device information of 28181 based on puid
        • Based on the national standard ID, get the device information of 28181
        • Add channel information
        • Modify channel information
        • Delete channel information
        • Get channel information
        • Get the list of 28181 channels
        • Add a parent platform device
        • Delete the parent platform device
        • Get the list of parent platform devices
      • Map Label
        • Create a map point label
        • Modify map point labels
        • Query the list of map point labels
        • Query map point label information
        • Create a map line label
        • Modify map line labels
        • Query the list of map line labels
        • Query map line label information
        • Create a map surface label
        • Modify the map surface label
        • Query the map surface label list
        • Query map surface label information
        • Add map label positioning point
        • Modify the map label positioning point
        • Delete map label positioning point
        • Delete map labels
        • Query the list of map label positioning points
        • Query map label positioning point information
      • Video File Timeline
        • Add
        • Delete
        • Query
      • 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 device association - modify
        • Plan device association - Delete
        • Plan device association - Query
        • Plan device association - query unassociated
        • Manual recording - Start
        • Manual recording - end
        • Take a picture with the device
      • Platform storage status
        • Download the list of plans
        • Download the list of devices associated with the plan
        • Downloading list
        • Device File List
        • Retry/Download Priority
        • Redownload (downloaded file)
        • Conversation List
        • Close the session
        • Video Plan Log - Device
        • Video Plan Log - Video Plan
      • Contact
        • Cancel the top
        • Add to top
        • Get the top list
      • Module program
        • cs app query
        • cs app batch modification
        • cs app modification
        • webapp query
        • webapp get home page
        • webapp set homepage
        • webapp get configuration
        • Webapp settings configuration
        • plugapp query
        • module query
      • Black and white list
        • Get the black and white list configuration
        • Modify the black and white list configuration
        • Get the black and white list
        • Delete the black and white list
        • Add to the black and white list
      • Media stream operations
        • Close the session
        • Open the device's audio and video stream webrtc
        • Open the device video and audio stream bvrtc
        • Open the voice meeting flow webrtc
        • Open the voice conference stream bvrtc
        • Open the voice conference flow websocket
        • Open the playback audio and video stream
        • Playback Control
        • View the conversation list
        • Get session information
        • Check the list of streaming services
        • Reset media service statistics
      • Station Management
        • Enter the collection station
        • Get the list of collection stations
        • Get the information of collection station
        • Modify the collection station information
        • Delete the device information
        • Kick collection station offline
      • The collection station is connected
        • The collection station is online
        • The collection station is offline
        • The collection station keeps alive
        • Report file index
        • Get file information
        • Delete files
      • Platform file classification
        • Get the list of file classifications
        • Get file classification information
        • Create a file classification
        • Modify file classification
        • Delete file classification
        • File binding classification
  1. websocket

Command Interact Subscription

GET
https://192.168.88.11:9781/bvcsp/v1/ws/command
Last modified:2025-02-26 09:23:29
Subscribe to the commands issued by the platform. When replying to the command, the ID needs to correspond to the received command and reply within the timeout (milliseconds). Otherwise, the backend will consider it as a timeout failure. The data structure of data is in the separate command description document. Contact sales or technical support for more information.

Request

Query Params

Header Params

Body Params application/json

Example
{
    "id": "string",
    "method": "get",
    "command": "conf_join",
    "timeout": 0,
    "page": 0,
    "pageSize": 0,
    "data": {}
}

Request 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/command' \
--header 'Sec-WebSocket-Protocol: string' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "string",
    "method": "get",
    "command": "conf_join",
    "timeout": 0,
    "page": 0,
    "pageSize": 0,
    "data": {}
}'

Responses

🟢200Success
application/json
Body

Example
{
    "id": "string",
    "code": 0,
    "msg": "string",
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "totalCount": 0
    },
    "data": {}
}
Modified at 2025-02-26 09:23:29
Previous
Meeting Event Subscription
Next
Platform file retrieval
Built with