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

listDeviceAbility - Obtain Capabilities of Multiple Devices and Accessories - Imou Open Platform

listDeviceAbility: Obtain the capability set of multiple devices, channels and accessories in batches

Function details

Ability to obtain multiple devices, channels, and accessories in batches

Request address

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

Incoming parameter description

Parameter name Parameter type Is it required? Default value Legal value Parameter description
token String Yes Administrator accessToken
deviceList deviceId String Yes List of device serial numbers
channelList String Yes "1,2,3,4,5": Multiple channel numbers separated by commas List of channel numbers
apList String No "1,2,3,4,5": multiple part numbers separated by commas Accessory Id list

Sample input

{
    "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
    "system":{
        "ver":"1.0",
        "appId":"lcdxxxxxxxxx",
        "sign":"74bc756ebd53e9eef2836f8cf1730c10",
        "time":1599031074,
        "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
    },
    "params":{
        "token":"At_00006acr3456d12312d3grf60147de7ec",
        "deviceList":[{
            "deviceId":"TESTQWERXXXX",
            "channelList":"0",
            "apList":"TESTQWERXXXX"
        }]
    }
}

Return data field description

Field name Field type Field description
deviceList deviceId String Device serial number
ability String Equipment capability items, separated by commas, see device capability definition
channels channelId String Channel number
channelAbility String Channel capability set, separated by commas, such as AlarmMD, AudioTalk
aps apId String Accessory id
apAbility String Accessory capability items, separated by English commas, such as AudioTalk, PT

Sample output

{
  "result": {
    "msg": "The operation was successful.",
    "code": "0",
        "data": {
            "deviceList": [
                {
                    "channels": [
                        {
                            "channelAbility": "WLAN,MT,HSEncrypt,CloudStorage,LocalStorage,PlaybackByFilename,BreathingLight,RD,LocalRecord,XUpgrade,Auth,ModifyPassword,LocalStorageEnable,RTSV1,PBSV1,ESV1,PlaySound,Reboot,InfraredLight,LinkDevAlarm,AbAlarmSound,SCCode,RDV2,CK,AlarmMD,PT,AudioEncodeControlV2,FrameReverse,RemoteControl,MDW,MDS,HeaderDetect,SmartTrack,CloseCamera,CheckAbDecible,PT1,AudioTalk",
                            "channelId": "0"
                        }
                    ],
                    "aps": [],
                    "ability": "WLAN,MT,HSEncrypt,CloudStorage,LocalStorage,PlaybackByFilename,BreathingLight,RD,LocalRecord,XUpgrade,Auth,ModifyPassword,LocalStorageEnable,RTSV1,PBSV1,ESV1,PlaySound,Reboot,InfraredLight,LinkDevAlarm,AbAlarmSound,SCCode,RDV2,CK,AlarmMD,PT,AudioEncodeControlV2,FrameReverse,RemoteControl,MDW,MDS,HeaderDetect,SmartTrack,CloseCamera,CheckAbDecible,PT1,AudioTalk",
                    "deviceId": "TESTQWERXXXX"
                }
            ]
        }
    },
    "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}
upgradeProcessDevice: Get device upgrade status and progress
subAccountDeviceInfo: Obtain the capability set of multiple devices, channels and accessories in batch