H Series OpenAPI Instructions
Home
ChineseVersion
Home
ChineseVersion
  1. IPC
  • Instructions
  • Error Codes
  • Change History
  • Devices
    • Read Device Detailed Information
    • Read Device Card Information
    • Read Device IP
  • Homepage
    • Read System Initialization Status
    • Read Video Server Address
  • Screen
    • Set Screen Gamma
    • Display Screen ID
    • Set Screen Brightness
    • Save Screen Brightness
    • Add Screens
    • Delete Screens
    • Read Screen Detailed Information
    • Query Screen List
    • Screen FTB
    • Set BKG
    • Set Freezing
    • Read Screen Not in Live Mode
    • Set 3D Effect
    • Set Screen Layout Information
    • Set Image OSD
    • Set Text OSD
    • Delete Multiple Screens
    • Rename Screens
  • 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
    • Delete BKG
    • Get BKG Detailed Information
    • Comprehensive Query
  • IPC
    • IPC Source List
      POST
    • Read Specified Data in IPC Source List
      POST
    • IP Camera List
      POST
    • Obtain IPC Source Channel List
      POST
    • Obtain Details of IPC Source Channel List
      POST
    • Details of IPC Mosaic Source Channel Data
      POST
    • Add IPC Sources
      POST
    • Delete IPC Sources
      POST
    • Rename IPC Sources
      POST
    • Change IPC Source Channels
      POST
    • Add IPC Source Channels
      POST
    • Delete IPC Source Channels
      POST
    • IPC Source Slot List
      POST
    • IPC Sources and Channels
      POST
    • Check IPC Source Names
      POST
    • IPC Source Group List
      POST
    • Create IPC Source Groups
      POST
    • Delete IPC Source Groups
      POST
    • Change IPC Groups
      POST
    • Delete IPC Source Group Nodes
      POST
    • IPC Mosaic Source List
      POST
    • Create IPC Mosaic Source Templates
      POST
    • Update IPC Mosaic Source Templates
      POST
    • Delete IPC Mosaic Source Templates
      POST
    • Apply IPC Mosaic Source Templates
      POST
    • Rename IPC Mosaic Sources
      POST
  1. IPC

IPC Source List

POST
/open/api/ipc/IPCSourceList
FieldDescription
deviceIdDevice ID
seqPageIndexThe page numbers start from 0, thus the smallest value to be passed is 1.
seqPageSizeNumber of data on each page
decodeCapacityIPC specifications (optional) 2: 2 million pixels, 3: 4 million pixels, 1: 8 million pixels, 4: 12 million pixels
nameIPC source name (optional)
ipIPC source IP (optional)
sourceTypeSource type
ipcTypeIPC type (0: IPC, 1: NVR)
channelCountChannel quantity
slotIdSlot ID
numsQuantity
transProtocol: Streaming protocol (1: TCP, 0: UDP)

Request

Body Params application/json

Example
{
    "body": {
        "slotId": 0,
        "deviceId": 0,
        "seqPageIndex": 1,
        "seqPageSize": 10
    },
    "sign": "MDBmZjQ1NzgxMGFjNGNhZTQ2N2U3ZTc4ODk0YTBiN2M=",
    "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/ipc/IPCSourceList' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body": {
        "slotId": 0,
        "deviceId": 0,
        "seqPageIndex": 1,
        "seqPageSize": 10
    },
    "sign": "MDBmZjQ1NzgxMGFjNGNhZTQ2N2U3ZTc4ODk0YTBiN2M=",
    "pId": "1",
    "timeStamp": "1631949094265"
}'

Responses

🟢200Successful
application/json
Body

Example
{
    "body": {
        "deviceId": 0,
        "nums": 22,
        "seqPageIndex": 0,
        "seqPageSize": 10,
        "slotId": 0,
        "sourceList": [
            {
                "channelCount": 1,
                "createTime": "",
                "decodeCapacity": 4,
                "deviceId": 0,
                "ip": "10.10.101.160",
                "ipcType": 0,
                "slotId": 255,
                "sourceId": 9,
                "sourceName": "661",
                "sourceType": 3,
                "transProtocol": 1
            },
            {
                "channelCount": 1,
                "createTime": "",
                "decodeCapacity": 2,
                "deviceId": 0,
                "ip": "10.40.228.174",
                "ipcType": 0,
                "slotId": 255,
                "sourceId": 8,
                "sourceName": "IP CAMERA",
                "sourceType": 3,
                "transProtocol": 1
            },
            {
                "channelCount": 1,
                "createTime": "",
                "decodeCapacity": 2,
                "deviceId": 0,
                "ip": "10.40.228.177",
                "ipcType": 0,
                "slotId": 255,
                "sourceId": 7,
                "sourceName": "7J0A964PAG01334",
                "sourceType": 3,
                "transProtocol": 1
            },
            {
                "channelCount": 1,
                "createTime": "",
                "decodeCapacity": 4,
                "deviceId": 0,
                "ip": "10.40.228.178",
                "ipcType": 0,
                "slotId": 255,
                "sourceId": 6,
                "sourceName": "10.40.228.178",
                "sourceType": 3,
                "transProtocol": 1
            },
            {
                "channelCount": 1,
                "createTime": "",
                "decodeCapacity": 2,
                "deviceId": 0,
                "ip": "10.10.100.211",
                "ipcType": 0,
                "slotId": 255,
                "sourceId": 5,
                "sourceName": "TestName1",
                "sourceType": 3,
                "transProtocol": 1
            },
            {
                "channelCount": 1,
                "createTime": "",
                "decodeCapacity": 2,
                "deviceId": 0,
                "ip": "10.10.100.36",
                "ipcType": 0,
                "slotId": 255,
                "sourceId": 4,
                "sourceName": "36",
                "sourceType": 3,
                "transProtocol": 1
            },
            {
                "channelCount": 16,
                "createTime": "",
                "decodeCapacity": 2,
                "deviceId": 0,
                "ip": "10.40.226.40",
                "ipcType": 1,
                "slotId": 255,
                "sourceId": 3,
                "sourceName": "nvr",
                "sourceType": 3,
                "transProtocol": 1
            },
            {
                "channelCount": 1,
                "createTime": "",
                "decodeCapacity": 2,
                "deviceId": 0,
                "ip": "10.40.228.177",
                "ipcType": 0,
                "slotId": 255,
                "sourceId": 21,
                "sourceName": "228.177",
                "sourceType": 3,
                "transProtocol": 1
            },
            {
                "channelCount": 1,
                "createTime": "",
                "decodeCapacity": 4,
                "deviceId": 0,
                "ip": "10.40.228.171",
                "ipcType": 0,
                "slotId": 255,
                "sourceId": 20,
                "sourceName": "10.40.228.171",
                "sourceType": 3,
                "transProtocol": 1
            },
            {
                "channelCount": 1,
                "createTime": "1759990707.7909067",
                "decodeCapacity": 4,
                "deviceId": 0,
                "ip": "10.10.100.65",
                "ipcType": 0,
                "slotId": 255,
                "sourceId": 2,
                "sourceName": "10.10.100.65",
                "sourceType": 3,
                "transProtocol": 1
            }
        ]
    },
    "msg": "",
    "sign": "",
    "status": 0
}
Modified at 2025-10-23 10:26:25
Previous
Comprehensive Query
Next
Read Specified Data in IPC Source List
Built with