H Series OpenAPI Instructions
Home
ChineseVersion
Home
ChineseVersion
  1. BKG
  • Instructions
  • Error Codes
  • Change History
  • Devices
    • Read Device Detailed Information
      POST
    • Read Device Card Information
      POST
    • Read Device IP
      POST
  • Homepage
    • Read System Initialization Status
      POST
    • Read Video Server Address
      POST
  • Screen
    • Set Screen Gamma
      POST
    • Display Screen ID
      POST
    • Set Screen Brightness
      POST
    • Save Screen Brightness
      POST
    • Add Screens
      POST
    • Delete Screens
      POST
    • Read Screen Detailed Information
      POST
    • Query Screen List
      POST
    • Screen FTB
      POST
    • Set BKG
      POST
    • Set Freezing
      POST
    • Read Screen Not in Live Mode
      POST
    • Set 3D Effect
      POST
    • Set Screen Layout Information
      POST
    • Set Image OSD
      POST
    • Set Text OSD
      POST
    • Delete Multiple Screens
      POST
    • Rename Screens
      POST
  • Inputs
    • Read Input List
    • Read Detailed Information of Specified Inputs
    • Set Cropping
    • Delete
    • Edit Cropping
    • Set Resolutions
    • Set Timing
    • Create Input Groups
    • Sort Input Groups
    • Edit Groups
    • Delete Groups
    • Delete Input Sources by Groups
    • Import EDID
    • Rename
    • Create Signal Source Playlists
    • Read Signal Source Playlists
    • Edit Signal Source Playlist Information
    • Enable Signal Source Playlists
    • Delete Signal Source Playlists
  • Outputs
    • Set Image Quality
    • Set Gamma
    • Set Output Locating
    • Rename
    • Set Timing for 4K Output Card
    • Read Detailed Information
    • Read Output List
    • Se Output Timing
    • Set Output Resolutions
    • Set Areas Loaded by All-in-One Cards
  • Layers
    • Set Stream Pulling Rules for IPC Sources Only
    • Add Layers
    • Delete Layers
    • Read Layer List
    • Read Layer Details
    • Set Layer Basic Information
    • Read Layer Z-order
    • Set Layer Information
    • Clear Layers
    • Set Layer Z-order
    • Lock Layers
    • Change Layer Source Information
    • Freeze Layers
    • Open Layer Layouts
  • Presets
    • Create Presets
    • Delete Presets
    • Set Basic Information of Specified Presets
    • Load Presets
    • Read Detailed Information of Specified Presets
    • Clear Presets
    • Get Preset Group List
    • Create Preset Groups
    • Delete Preset Groups
    • Get Preset Group Enumeration
    • Play Preset Playlist
    • Read All Presets
    • Read Preset Playlist
    • Read Current Played Preset
    • Edit Preset Groups
    • Overwrite Presets
  • BKG
    • Create BKG
      POST
    • Delete BKG
      POST
    • Get BKG Detailed Information
      POST
    • Comprehensive Query
      POST
  • IPC
    • IPC Source List
    • Read Specified Data in IPC Source List
    • IP Camera List
    • Obtain IPC Source Channel List
    • Obtain Details of IPC Source Channel List
    • Details of IPC Mosaic Source Channel Data
    • Add IPC Sources
    • Delete IPC Sources
    • Rename IPC Sources
    • Change IPC Source Channels
    • Add IPC Source Channels
    • Delete IPC Source Channels
    • IPC Source Slot List
    • IPC Sources and Channels
    • Check IPC Source Names
    • IPC Source Group List
    • Create IPC Source Groups
    • Delete IPC Source Groups
    • Change IPC Groups
    • Delete IPC Source Group Nodes
    • IPC Mosaic Source List
    • Create IPC Mosaic Source Templates
    • Update IPC Mosaic Source Templates
    • Delete IPC Mosaic Source Templates
    • Apply IPC Mosaic Source Templates
    • Rename IPC Mosaic Sources
  1. BKG

Get BKG Detailed Information

POST
/open/api/bkg/readDetail
Description
general: Basic information
deviceId: Device ID
bkgId: BKG ID
name: BKG name
data: Image search result
image: Image data
thumbnailData: Tumbnail data

Request

Body Params application/json

Example
{
    "body": {
        "deviceId": 0,
        "bkgId": 0
    },
    "sign": "MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId": "1",
    "timeStamp": "1631949094265"
}

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 POST '/open/api/bkg/readDetail' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body": {
        "deviceId": 0,
        "bkgId": 0
    },
    "sign": "MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId": "1",
    "timeStamp": "1631949094265"
}'

Responses

🟢200Successful
application/json
Body

Example
{
    "body": {
        "bkgId": 0,
        "data": {
            "image": {
                "createTime": "1759045134.549195",
                "fileLength": 0,
                "fileName": "./data/BKGImage/17590451345451.jpg",
                "hashSum": 22015,
                "height": 1080,
                "imgUrl": "/data/BKGImage/17590451345451.jpg",
                "width": 1920
            }
        },
        "deviceId": 0,
        "general": {
            "name": "BKG-1"
        },
        "thumbnailData": {
            "bkgId": 0,
            "deviceId": 0,
            "image": {
                "fileLength": 0,
                "fileName": "/usr/Hseries/bin/web/H_9U/H_9U/static/thumbnail/17590451345451_thumbnail.jpg",
                "hashSum": 22015,
                "height": 0,
                "imgUrl": "thumbnail/17590451345451_thumbnail.jpg",
                "width": 0
            }
        }
    },
    "msg": "",
    "sign": "",
    "status": 0
}
Modified at 2025-10-23 10:26:02
Previous
Delete BKG
Next
Comprehensive Query
Built with