unBindDeviceInfo (UnBindDeviceInfo - Unbound Device Information Acquisition - Imou Open Platform)

unBindDeviceInfo: UnBindDeviceInfo - Unbound Device Information Acquisition - Imou Open Platform

Deprecated: Use Pre-bind information (device.prebind.get). This legacy HTTP page is retained for existing integrations.

Function details

Query the unbound device information.

Request address

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

Request format

HTTP POST. JSON body layout: Request conventions. Sign with Signature.

The sub-account token can be requested without permission

Incoming parameter description

Parameter name	Parameter type	Required or not	Parameter description
token	String	Yes	Administrator or sub-account accessToken
deviceId	String	Yes	Device serial number
productId	String	No	model device product ID, which can be obtained by scanning the device QR code
deviceCodeModel	String	No	The device QR code model, which can be obtained by scanning the device QR code
deviceModelName	String	No	Device market model
ncCode	String	No	Equipment network configuration capability, can be obtained by scanning the equipment QR code

Sample input

{
 "id": "115d93268c8c4325920be6c9d3f5e855",
 "system": {
 "ver": "1.0",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "appId": "lcdxxxxxxxxx",
 "time": 1404443389,
 "nonce": "169431af9750408da8aeeb7d07f93c4e"
 },
 "params": {
 "token": "At_12345678901234567890123456789012",
 "deviceId": "TESTQWERXXXX",
 "deviceCodeModel": "TP1",
 "deviceModelName": "TP1-Popular Edition",
 "ncCode": "64"
 }
}

Return data field description

Field name	Field type	Field description
support	Boolean	Does the platform support the device: true: support, false: not support
productId	String	model device product ID
deviceExist	String	Does the device exist on the platform: "exist": exists, "notExist": does not exist
status	String	Device status: `online`, `offline`, `upgrading`, `sleep` (hibernation)
bindStatus	String	Device binding status: unbind: device is not bound
wifiConfigMode	String	Pairing modes supported by the device: SmartConfig, SoundWave, SoftAP, LAN, SIMCard, QRCode, SoundWaveV2, NBIOT, Bluetooth accessories do not return
wifiConfigModeOptional	Boolean	Does the device support user-selected and available network configuration methods: true: support optional, false: not support optional
wifiTransferMode	String	The sequence of the device's wireless support frequency band: 2.4Ghz, 5Ghz
deviceCodeModel	String	Device reported model
deviceModelName	String	Device market model
catalog	String	Equipment categories: NVR/DVR/HCVR/IPC/SD/IHG/ARC
ability	String	Equipment ability set
type	String	Hardware type: device:device ap:accessory

Sample output

{
 "id": "115d93268c8c4325920be6c9d3f5e855",
 "result": {
 "data": {
 "support": true,
 "deviceExist": "exist",
 "status": "online",
 "bindStatus": "unbind",
 "wifiConfigMode": "SoundWave",
 "wifiConfigModeOptional": false,
 "wifiTransferMode": "2.4Ghz",
 "deviceCodeModel": "TP1",
 "deviceModelName": "TP1-Popular Edition",
 "catalog": "IPC",
 "ability": "WLAN,PT",
 "type": "device"
 },
 "code": "0",
 "msg": " Operation is successful."
 }
}

Error codes

This method may return the codes below. See Return codes and Capability errors for the full catalog.

Gateway and auth (SN / TK / OP)

Code	Meaning	Next step
`SN1001`	Signature error	Check `sign` per Development specification
`TK1002`	Token invalid or expired	Refresh accessToken
`OP1002`	Missing required parameter	Add required fields
`OP1003`	Invalid parameter	Match this page’s parameter table
`OP1009`	Permission denied	Check token and device bind/share grants
`OP1013`	Total call limit exceeded	Reduce call rate
`OP1014`	Daily per-interface limit exceeded	See Interface call limits
`DV1007`	Device offline	Wait until the device is online

See Return codes · OP/SN/TK for the full catalog.

Sub-accounts (SUB)

Code	Meaning	Next step
`SUB1001`–`SUB1002`	Sub-account lacks API permission	Update policy via addPolicy
`SUB1005`	Sub-account token expired	Refresh subAccountToken
`SUB1006`	No device grant for sub-account	Check `Resource` and device serial
`SUB1008`	Sub-account not bound to app	Create and bind the sub-account first

See Return codes · SUB.

Device binding (DV10xx)

Code	Meaning	Next step
`DV1001`	Bound to another account	Unbind or use another device
`DV1002`	Device does not exist	Verify serial number
`DV1003`	Already bound to current account	No need to bind again
`DV1005`	Verification code error	Check device label code
`DV1008`	Bind count limit exceeded	Unbind extra devices
`DV1011`	Device not bound	Bind first
`DV1029`	Device already bound	Do not bind again

See Return codes · DV.