Getting Started
Official Site
Getting Started
Official Site
  • Document description
  • Read before you start

  • Light application development guide

  • Mobile application development guide

  • Cloud live development guide

  • Desktop application development guide

  • Third party development guide

  • Message push development guide

  • IoT things data model

  • HTTP interface

    • Development specification
    • API privacy policy
    • Postman interface simulation call
    • accessToken: Get administrator token
    • API request example
    • Account docking
    • Push configuration
    • Cloud storage service
    • Equipment management

      • Add device
      • Device query
        • listDeviceDetailsByIds: Batch query of device details
        • listDeviceDetailsByPage: Paging device details for querying
        • deviceOnline: Get device online status
        • unBindDeviceInfo: Unbound device information acquisition
        • checkDeviceBindOrNot: Query device binding status
        • bindDeviceChannelInfo: Obtain the detailed information of a single device channel
        • deviceVersionList: Get device version and upgradeable information
        • deviceOpenList: Paging to obtain the basic information of the channel for adding devices to the open platform
        • queryOpenDeviceChannelInfo: Obtain the basic information of the channel for adding devices to the open platform
        • deviceOpenDetailList: Get detailed device information in batches
        • deviceBaseList: Paging to obtain the basic information of the device channel added or shared by the easy4ip app
        • queryBaseDeviceChannelInfo: Get the basic information of the channel added or shared by the easy4ip app
        • deviceBaseDetailList: Get detailed information of devices added or shared by easy4ip app in batches
        • shareDeviceList: Paging to get the device list shared by the easy4ip app to the developer
        • upgradeProcessDevice: Get device upgrade status and progress
        • listDeviceAbility: Obtain the ability set of multiple devices, channels and accessories in batch
        • subAccountDeviceInfo: Obtain the capability set of multiple devices, channels and accessories in batch
        • subAccountDeviceList: Get the capability set of multiple devices, channels and accessories in batch
      • Device maintenance
    • Device configurat

    • Video equipment

    • Device message
    • Device live broadcast
    • Device lock access
  • Reference documents

On this page
Function details
Request address
Incoming parameter description
Sample input
Return data field description
Sample output

Detailed Info of Authorized Devices for Sub-Accounts - Imou Open Platform

subAccountDeviceInfo: Get the detailed information of the authorized device specified under the sub-account

Function details

Get the detailed information of the authorized device specified under the sub-account, only sub-account token call

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/subAccountDeviceInfo

Incoming parameter description

Parameter name Parameter type Is it required? Default value Legal value Parameter description
token String Yes Subaccount token
deviceList deviceId String Yes List of device serial numbers, up to 8 device queries are supported
channelList String No "1,2,3,4,5": Multiple channel numbers are separated by commas. If it is empty, all device channels will be queried. List of channel numbers
apList String No "1,2,3,4,5": multiple part numbers separated by commas Accessory Id list

Sample input

{
  "system": {
    "ver": "1.0",
    "appId": "lcdxxxxxxxxx",
    "sign": "b5aef5e8c1033e0f6aa949e1e1174425",
    "time": 1626313585,
    "nonce": "93686fc7-153e-41b7-924b-834a901b98b4"
  },
  "id": "4f1dead2-ff99-49a7-a996-e996d56711b9",
  "params": {
    "deviceList": [
      {
        "channelList": "0",
        "apList": "0,1",
        "deviceId": "TESTQWERXXXX"
      }
    ],
    "token": "At_000085fa18f0319046199b2138c04e54"
  }
}

Return data field description

Field name Field type Field description
deviceList deviceId String Device serial number
status String Device status, online: online, offline: offline, sleep: hibernation, upgrading
deviceModel String Device model
catalog String Equipment category [NVR/DVR/HCVR/IPC/SD/IHG/ARC]
version String Device software version number
name String Device name
permission String Device permissions, if only channel-level permissions are authorized, this field does not return content
ability String Equipment capability items, separated by commas, see device capability set for details
accessType String Device access type, PaaS-means Paas program access, Lechange-means easy4ip non-PaaS equipment, Easy4IP means Easy4IP program equipment, P2P means P2P program equipment
encryptMode String Encryption mode, 0: default encryption mode, 1: user-defined encryption mode
channelNum String The number of channels that the device can access
channels channelId String Channel number
channelName String Channel name
ability String Channel capability set, such as AlarmMD, AudioTalk, separated by commas
status String Remote channel status, online: online, offline: offline, close: not configured, sleep: hibernation, upgrading in progress
permission String Channel authority, if only the device level authority is authorized, fill in according to the device level authority
picUrl String Thumbnail URL
resolutions name String the name of the resolution displayed on the client interface
imageSize Integer resolution enumeration
streamType Integer stream type, 0: HD main stream, 1: SD secondary stream
aplist apId String Accessory id
apName String Accessory name
apType String Accessories type
apModel String Model of the accessory
ioType String The io type of the accessory, in: input, out: output
apVersion String The version number of the accessory
apStatus String Online status of accessories, online: online, offline: offline
apEnable String Enable the accessory, on: enable to open, off: enable to close
apCapacity String Accessory capability items, separated by commas, such as AudioTalk, PT

Sample output

{
    "result": {
        "msg": "The operation was successful.",
        "code": "0",
        "data": {
            "deviceList": [{
                "accessType": "PaaS",
                "catalog": "NVR",
                "encryptMode": 0,
                "name": "NVR-4993",
                "channelNum": "64",
                "deviceModel": "DH-NVR5232-I",
                "permission": "",
                "ability": "Auth,DHP2P,CloudStorage,LocalStorage,RD,LocalRecord",
                "deviceId": "TESTQWERXXXX",
                "version": "2.145.1000.0.R.20181112",
                "status": "offline",
                "channels": [{
                    "picUrl": "",
                    "channelName": "NVR-4993-4",
                    "permission": "Alarm,Talk,Ptz,Config,Upgrade",
                    "ability": "PTZ,MDW,MDS,ChnLocalStorage",
                    "channelId": "3",
                    "status": "offline",
                    "resolutions":[{
                        "name":"1080P",
                        "imageSize":18,
                        "streamType":0
                    }]
                }],
                "aplist":[{
                    "apId":"APXXXXXXXXXXX",
                    "apName":"cname",
                    "apType":"ability",
                    "apModel":"wbs",
                    "ioType":"auto",
                    "apVersion":"V1.2.3",
                    "apStatus":"online",
                    "apEnable":"on",
                    "apCapacity":"AudioTalk,PT"
                }]
            }]
        }
    },
    "id": "733b6b5c-05ce-4734-b407-e30dac44e637"
}
listDeviceAbility: Obtain the ability set of multiple devices, channels and accessories in batch
subAccountDeviceList: Get the capability set of multiple devices, channels and accessories in batch