wifiAround (WifiAround - WIFI Information Around the Device - Imou Open Platform)

wifiAround: WifiAround - WIFI Information Around the Device - Imou Open Platform

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

Function details

Get WIFI information around the device.

Request address

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

Request format

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

Minimum permissions required for sub-account token request

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

Incoming parameter description

Parameter name	Parameter type	Required or not	Default value	Legal value	Parameter description
token	String	Yes			Administrator or sub-account accessToken
deviceId	String	Yes			Device serial number

Sample input

{
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1603365887,
 "nonce":"a7cfc219-4883-4d3b-aa86-b9b1b4db4eb7"
 },
 "id":"37c233a4-84f3-4265-be99-78e4d3370bae",
 "params":{
 "deviceId":"TESTQWERXXXX",
 "token":"At_00000ad9e6e87f0142eb92e207aec46a"
 }
}

Return data field description

Field	Type	Description
enable	Boolean	Whether wifi is turned on
wLan.ssid	String	SSID, hotspot ID
wLan.bssid	String	BSS ID, usually a MAC address
wLan.linkStatus	Integer	Connection status, 0: not connected, 1: connecting, 2: connected
wLan.auth	String	Authentication mode: OPEN, WEP, WPA/WPA2 PSK, WPA/WPA2
wLan.intensity	Integer	Strength, 0 is the weakest, 5 is the strongest

Sample output

{
 "result":{
 "msg":"The operation was successful.",
 "code":"0",
 "data":{
 "wLan":[
 {
 "linkStatus":2,
 "intensity":5,
 "auth":"WPA/WPA2 PSK",
 "bssid":"12:34:56:78:90:12",
 "ssid":"TP_DiamondC"
 },
 {
 "linkStatus":0,
 "intensity":5,
 "auth":"OPEN",
 "bssid":"11:34:56:78:90:12",
 "ssid":"TP_PHEGDA"
 },
 {
 "linkStatus":0,
 "intensity":5,
 "auth":"WPA/WPA2",
 "bssid":"12:34:56:78:90:22",
 "ssid":"TP_Lechnage"
 }
 ],
 "enable":true
 }
 },
 "id":"37c233a4-84f3-4265-be99-78e4d3370bae"
}

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

Code	Meaning	Next step
`DV1007`	Device offline or timeout	Wait for the device to come online
`DV1009`	Device busy	Retry later
`DV1012`	Insufficient share/grant permission	Check sub-account `Permission` / `Resource`
`DV1019`	Capability not supported	Confirm model and capability list
`DV1020`	Channel offline	Check channel status
`DV1026`	Function not supported	Use another API or upgrade firmware
`DV1028`	Not bound or channel missing	Verify `deviceId` / `channelId`

See Return codes · DV.