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

shareDeviceList - Device List Pagination from easy4ip App - Imou Open Platform

shareDeviceList: Pagination to get the device list shared by the easy4ip app to the developer

Function details

Get a list of devices shared by the easy4ip app to the developer by pagination.

Request address

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

Incoming parameter description

| Parameter name | Parameter type | Required or not | Default value | Legal value | Parameter description | | :------------- | :------------- | :-------------- | :------------ | :---------------------------------------------------------------------------------------------------------------------------- | :------------------------ | | | token | String | Yes | | | Administrator accessToken | | queryRange | String | Yes | | The number value range is: [1,N] (N is a positive integer, and the latter>the former); the difference value range is: [0, 99] | Up to the number of data |

Sample input

{
    "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
    "system":{
        "ver":"1.0",
        "appId":"lcdxxxxxxxxx",
        "sign":"74bc756ebd53e9eef2836f8cf1730c10",
        "time":1599031074,
        "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
    },
    "params":{
        "token":"At_00006acr3456d12312d3grf60147de7ec",
        "queryRange":"1-10"
    }
}

Return data field description

Field name Field type Field description
count Integer Total amount of equipment
deviceList deviceId String Device serial number
status Integer Device status, 1: online, 0: offline
baseline String Device baseline type
deviceModel String Device model
deviceCatalog String Equipment category [NVR/DVR/HCVR/IPC/SD/IHG/ARC]
brand String Equipment brand information: lechange-easy4ip equipment, general-general equipment
version String Device software version number
name String Device name
ability String Equipment capability items, separated by commas, see device capability set for details
canBeUpgrade Boolean Is there a new version that can be upgraded, true: There is a new version that can be upgraded; false: No upgrade is possible
ownerUsername String Device owner account
platForm Integer Device access platform number, 0: means only p2p is supported, 1: means access to the old easy4ip access platform, 2: means easy4ip paas equipment access platform, 3: means domestic non-pass equipment, 4: means domestic pass Device, -1: indicates an unknown platform
encryptMode String Encryption mode, 0: default encryption mode, 1: user-defined encryption mode
playToken String Device playback code, used by opensdk
channels channelId String Channel number
channelName String Channel name
channelOnline Boolean Whether online, true: online, false: offline
channelPicUrl String Thumbnail URL
channelAbility String Channel capability set, such as AlarmMD, AudioTalk, separated by commas
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

Sample output

{
  "result":{
    "msg":"The operation was successful.",
        "code":"0",
        "data":{
            "count":1,
            "deviceList":[{
                "deviceId":"TESTQWERXXXX",
                "status":1,
                "baseline":"ABC",
                "deviceModel":"CE-A-TP1",
                "deviceCatalog":"SD",
                "brand":"lechange",
                "version":"Chn_A_V1.1",
                "name":"deviceName",
                "ability":"AlarmMD,AudioTalk,AlarmPIR,WLAN,VVP2P",
                "canBeUpgrade":false,
                "ownerUsername":"13512341234",
                "platForm":4,
                "encryptMode":"0",
                "playToken":"qwejhfdhrubfsdbisjfasnd",
                "channels":[{
                    "channelId":"0",
                    "channelName":"channelName",
                    "channelOnline":true,
                    "channelPicUrl":"http://xxx.xx.com/xxx/3.jpg",
                    "channelAbility":"WLAN,PTZ,AudioTalk",
                    "resolutions":[{
                        "name":"1080P",
                        "imageSize":18,
                        "streamType":0
                    }]
                }]
            }]
        }
    },
    "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}
deviceBaseDetailList: Get detailed information of devices added or shared by easy4ip app in batches
upgradeProcessDevice: Get device upgrade status and progress