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)
      • 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)
        • Control Device WIFI Connection Hotspot Development Guide - Imou Open Platform
        • Current Device WiFi - Device Connected Hotspot Info - Imou Open Platform
        • WifiAround - WIFI Information Around the Device - Imou Open Platform
      • Local recording query (legacy)
  • SDK and tools
  • Solutions
  • Platform and support
On this page
Function details
Request address
Request format
Minimum permissions required for sub-account token request
Incoming parameter description
Sample input
Return data field description
Sample output
Error codes
Related

currentDeviceWifi (Current Device WiFi - Device Connected Hotspot Info - Imou Open Platform)

currentDeviceWifi: Current Device WiFi - Device Connected Hotspot Info - Imou Open Platform

Deprecated: Use Current Wi-Fi (device.wifi.current). This legacy HTTP page is retained for existing integrations.

Function details

Get the hotspot information that the device is currently connected to.

Remarks: In overseas (non-China) deployments, data may also include sigStrength (String, e.g. RSSI in dBm). The field is omitted in the China region.

Request address

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

Request format

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

Minimum permissions required for sub-account token request

The sub-account accessToken policy must include Config; device resource URI is dev:{deviceId}. See Permission codes.

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":1603366027,
 "nonce":"48404de7-2d6b-44e0-8c01-fd064a11ee12"
 },
 "id":"e3f44f71-1ed0-40fc-b38e-aca69c945ac9",
 "params":{
 "deviceId":"TESTQWERXXXX",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a"
 }
}

Return data field description

FieldTypeDescription
linkEnableBooleanWhether wifi is connected, true: yes, false: no
ssidStringThe name of the hotspot currently connected
intensityIntegerStrength, 0 is the weakest, 5 is the strongest
sigStrengthStringWi-Fi signal strength (e.g. dBm). Overseas deployments only; omitted in China region

Sample output

{
 "result":{
 "msg":"The operation was successful.",
 "code":"0",
 "data":{
 "intensity":"5",
 "sigStrength":"-55",
 "ssid":"TP_DiamondC",
 "linkEnable":true
 }
 },
 "id":"e3f44f71-1ed0-40fc-b38e-aca69c945ac9"
}

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 access and channels (DV10xx)

CodeMeaningNext step
DV1007Device offline or timeoutWait for the device to come online
DV1009Device busyRetry later
DV1012Insufficient share/grant permissionCheck sub-account Permission / Resource
DV1019Capability not supportedConfirm model and capability list
DV1020Channel offlineCheck channel status
DV1026Function not supportedUse another API or upgrade firmware
DV1028Not bound or channel missingVerify deviceId / channelId

See Return codes · DV.

Related

  • Development specification
  • API conventions
  • Current Wi-Fi
  • Module index
Control Device WIFI Connection Hotspot Development Guide - Imou Open Platform
WifiAround - WIFI Information Around the Device - Imou Open Platform