Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
  • API reference
    • Public conventions
    • Development specification
    • accessToken: Get administrator token
    • API request example
    • Return codes
    • Interface call limits
    • Account docking
    • Device APIs
    • Device live broadcast
    • Push configuration
    • Cloud storage service
    • Resource pool quota
    • Legacy APIs (deprecated)
      • Door lock access (legacy)
      • Device messages (legacy)
      • Device query (deprecated)
        • checkDeviceBindOrNot
        • deviceOnline
        • listDeviceDetailsByIds
        • listDeviceDetailsByPage
        • unBindDeviceInfo
        • upgradeProcessDevice
        • bindDeviceChannelInfo
        • bindDeviceInfo
        • bindDeviceList
        • deviceBaseDetailList
        • deviceBaseList
        • deviceList
        • deviceOpenDetailList
        • deviceOpenList
        • deviceVersionList
        • listDeviceAbility
        • queryBaseDeviceChannelInfo
        • queryOpenDeviceChannelInfo
        • shareDeviceList
      • Device maintenance (legacy)
      • Device operation (legacy)
      • Device ability (legacy)
      • Motion detection config (legacy)
      • Preset collection (legacy)
      • Timed cruise (legacy)
      • Local recording config (legacy)
      • Audio volume (legacy)
      • Storage (legacy)
      • Video and imaging (legacy)
      • Time zone (legacy)
      • Wi-Fi (legacy)
      • Local recording query (legacy)
  • SDK and tools
  • Solutions
  • Platform and support
On this page
Function details
Request address
Request format
The sub-account token can be requested without permission
Incoming parameter description
Sample input
Return data field description
Sample output
Error codes
Related

checkDeviceBindOrNot (checkDeviceBindOrNot - Query Device Binding Status - Imou Open Platform)

checkDeviceBindOrNot: checkDeviceBindOrNot - Query Device Binding Status - Imou Open Platform

Deprecated: Use Bind state (device.bindstate.get). This legacy HTTP page is retained for existing integrations.

Function details

Query the device binding status, whether it is bound, and whether it is bound by the current account.

Request address

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

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 nameParameter typeRequired or notDefault valueLegal valueParameter description
tokenStringYesAdministrator or sub-account accessToken
deviceIdStringYesDevice serial number

Sample input

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1603370290,
 "nonce":"90ad5f98-b1c6-4c2c-9514-7eb98bee3e24"
 },
 "id":"d51dd218-0563-4293-966b-bb1004532143",
 "params":{
 "deviceId":"TESTQWERXXXX",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a"
 }
}

Return data field description

FieldTypeDescription
isBindBooleanWhether it is bound to an account, true: it has been bound, false: it has not been bound
isMineBooleanWhether it belongs to the current account, true: belongs to the current account, false: does not belong to the current account

Sample output

{
 "result":{
 "msg":"The operation was successful.",
 "code":"0",
 "data":{
 "isBind":true,
 "isMine":true
 }
 },
 "id":"d51dd218-0563-4293-966b-bb1004532143"
}

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)

CodeMeaningNext step
SN1001Signature errorCheck sign per Development specification
TK1002Token invalid or expiredRefresh accessToken
OP1002Missing required parameterAdd required fields
OP1003Invalid parameterMatch this page’s parameter table
OP1009Permission deniedCheck token and device bind/share grants
OP1013Total call limit exceededReduce call rate
OP1014Daily per-interface limit exceededSee Interface call limits
DV1007Device offlineWait until the device is online

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

Sub-accounts (SUB)

CodeMeaningNext step
SUB1001–SUB1002Sub-account lacks API permissionUpdate policy via addPolicy
SUB1005Sub-account token expiredRefresh subAccountToken
SUB1006No device grant for sub-accountCheck Resource and device serial
SUB1008Sub-account not bound to appCreate and bind the sub-account first

See Return codes · SUB.

Device binding (DV10xx)

CodeMeaningNext step
DV1001Bound to another accountUnbind or use another device
DV1002Device does not existVerify serial number
DV1003Already bound to current accountNo need to bind again
DV1005Verification code errorCheck device label code
DV1008Bind count limit exceededUnbind extra devices
DV1011Device not boundBind first
DV1029Device already boundDo not bind again

See Return codes · DV.

Related

  • Development specification
  • API conventions
  • Bind state
  • Module index
getAlarmMessageById
deviceOnline