Paging Device Details for Querying - Imou Open Platform

listDeviceDetailsByPage: Paging device details for querying

Function details

Paging to obtain information about device channels under the account.

Request address

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

request format

Please refer to the Development Specification for the API request method and some authentication parameters such as sign calculation method

Incoming parameter description

Parameter name	Parameter type	Required or not	Default value	Legal value	Parameter description
pageSize	int	yes			Number of entries per page, range: 1-50
page	long	yes			Search page numbers, starting from 1
token	String	yes			Administrator or sub-account accessToken
source	String		bindAndShare	bind: Get bound devices share: Get shared devices bindAndShare: Get bound and shared devices	Relationship type, this parameter does not work when passed to sub accounts

Sample input

{
    "system": {
        "ver": "1.0",
        "appId": "lcdxxxxxxxxx",
        "sign": "xxxxxxxxxxxxxx",
        "time": 1603370757,
        "nonce": "1a411d5a-e88b-45ee-b590-53da98375edd"
    },
    "id": "beb24691-d173-473a-8d3d-92db3aee0027",
    "params": {
        "deviceList": [{
            "deviceId": "TESTQWERXXXX",
            "channelId": ["0"]
        }],
        "token": "xxxxxxxxxxxxxxxxxxxxxxxxx"
    }
}

Return data field description

Field name				Field type	Field description
count				Integer	The number of devices found in this query
deviceList	upgradeInfo
			version	String	Latest version number
			attention	String	Upgrade description information
			packageUrl	String	Download address
	deviceId			String	Device serial number
	productId			String	unique id of product
	canBeUpgrade			Boolean	Whether the device program can be upgraded
	accessType			String	Device access type, PaaS - represents Paas program access, Lechange - represents imou non PaaS devices, Easy4IP represents Easy4IP program devices, P2P represents P2P program devices
	deviceVersion			String	Device version number
	playToken			String	Device playback code, used by OpenSDK
	brand			String	Device brand information, lechange - imou equipment, general - general equipment
	encryptMode			String	Device encryption mode: 0- Device default encryption 1- User defined encryption
	lastOffLineTime			String	Last offline time of the device
	deviceName			String	Device name
	deviceStatus			String	Device status, online/offline:/sleep/upgrading
	deviceModel			String	Device model
	catalog			String	Device categories, NVR/DVR/HCVR/IPC/SD/IHG/ARC
	deviceAbility			String	Device Capability Set, Comma Separated
	channelNum			Integer	The maximum number of channels supported by the device for access
	source			String	Permission type, bind/share
	isSubDevice			Boolean	Whether it is a sub-device
	parentDeviceId			String	The serial number of the parent device to which the child device belongs
	parentProductId			String	The productId of the parent device to which the child device belongs
	channelList	channelPicUrl		String	Cover image of channel
		csStatus		String	Cloud storage status, notExist: Package not activated, using: Cloud storage activated but not expired, expired: Package expired
		shareFunctions		String	Permission strings under shared permissions, separated by commas
		cameraStatus		String	Mask status, on: open, off: closed
		channelId		String	channel number
		channelName		String	Channel name
		channelAbility		String	Channel capability set, separated by commas
		channelStatus		String	Channel status, online/offline:/sleep/upgrading
		lastOffLineTime		String	Last offline time of the channel
		resolutions	name	String	The resolution name displayed on the client interface
			imageSize	Integer	Resolution enumeration
			streamType	Integer	Stream type, 0: main stream, 1: secondary stream
	subDeviceList		subDeviceProductId	String	Sub device product ID
			subDeviceId	String	Sub device serial number
			subDeviceName	String	Sub device name
			subDeviceModel	String	Sub device model
			subDeviceStatus	String	Sub device status, online/offline
	aplist		apId	String	Accessory ID
			apName	String	Accessory Name
			apType	String	Accessory Type

Sample output

{
    "result": {
        "msg": "Operation is successful.",
        "code": "0",
        "data": {
            "count": 1,
            "deviceList": [
                {
                    "catalog": "IPC",
                    "source": "bind",
                    "deviceId": "TESTQWERXXXX",
                    "deviceName": "TP7-XXXX",
                    "wifiTransferMode": "2.4Ghz",
                    "deviceStatus": "online",
                    "accessType": "PaaS",
                    "channelList": [
                        {
                            "csStatus": "using",
                            "shareFunctions": "",
                            "cameraStatus": "off",
                            "lastOffLineTime": "20230921T212756Z",
                            "channelName": "TP7-XXXX",
                            "channelStatus": "online",
                            "resolutions": [
                                {
                                    "streamType": 0,
                                    "name": "1080P",
                                    "imageSize": 18
                                },
                                {
                                    "streamType": 1,
                                    "name": "480P",
                                    "imageSize": 5
                                }
                            ],
                            "channelAbility": "CloseCamera,other,NVM,PT,WideDynamic",
                            "channelId": 0,
                            "channelPicUrl": ""
                        }
					],
                    "encryptMode": "0",
                    "tlsPrivatePort": "37778",
                    "brand": "lechange",
                    "devicePassword": "xxxxxxxxxxxx",
                    "playToken": "",
                    "deviceUsername": "xxxxxxxx==",
                    "salt": "xxxxxxxxxxxx",
                    "upgradeInfo": {
                        "packageUrl": "xxxxxxxxxxxxx",
                        "attention": "Improve device performance and reinforce safety",
                        "appForced": false,
                        "isAppForced": false,
                        "version": "V2.680.0000000.28.R.210911"
                    },
                    "httpPort": "80",
                    "rtspPort": "554",
                    "channelNum": 1,
                    "deviceVersion": "xxxxxxxxxxx",
                    "sdcardStatus": "normal",
                    "subDeviceList":[],
                    "aplist": [],
                    "deviceAbility": "WLAN,Auth,HSEncrypt,BreathingLight,CloudStorage,LocalStorage",
                    "lastOffLineTime": "20220926T164059Z",
                    "deviceModel": "TP7",
                    "canBeUpgrade": true
                }
            ]
        }
    },
    "id": "20tboni0x9z"
}