device.wifi.scan (Scan Wi-Fi hotspots)
device.wifi.scan: Scan Wi-Fi hotspots
What it does
Scans hotspots around the device. This method does not appear in device.capability.list. Typical order: Current Wi-Fi, then this scan, then Connect or disconnect Wi-Fi. accessPoints[].intensity on the scan API is 0–5; property pages Wi-Fi info / signal strength may use different enum levels—do not use scan results to validate RSSI properties directly.
Request URL
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.wifi.scan
Minimum permission
The administrator does not need an extra permission on a device they bound. A shared device needs the basic configuration permission. A bound sub-user does not. A sub-account needs Config.
Request parameters
| Name | Type | Required | Default | Legal values | Description |
|---|---|---|---|---|---|
token | String | yes | Access token for an administrator, sub-user, or sub-account | ||
deviceId | String | yes | Device serial number | ||
productId | String | no | Optional. If sent and it does not match the device model → DV2009 |
For common request fields and signing, see Signing conventions and Common request payload.
Request example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"system": {
"ver": "1.0",
"appId": "lcdxxxxxxxxx",
"sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
"time": 1706511734,
"nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
},
"params": {
"token": "<yourAccessToken>",
"deviceId": "TESTIPC000012345"
}
}
Response data fields
| Name | Type | Description |
|---|---|---|
enable | Boolean | Whether scan is enabled |
accessPoints | Array | Hotspot list (up to about 10 entries) |
accessPoints[].ssid | String | SSID |
accessPoints[].bssid | String | BSSID |
accessPoints[].auth | String | Authentication mode |
accessPoints[].linkStatus | Int | 0 not connected / 1 connecting / 2 connected |
accessPoints[].intensity | Int | Scan signal level 0–5 (not network.wifi.rssi property values) |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"enable": true,
"accessPoints": [
{
"ssid": "Home_5G",
"bssid": "12:34:56:78:90:12",
"auth": "WPA2",
"linkStatus": 2,
"intensity": 4
}
]
}
}
}
Error codes
This API may return the codes below.
| 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.
| Code | Meaning | Next step |
|---|---|---|
DV2003 | Property not on device | Use device.capability.list |
DV2004 | Value out of range | Check properties values |
DV2007 | channelId vs scope mismatch | Required for channel scope; omit for device scope |
DV2008 | Mixed device and channel properties | Split the request |
DV2009 | productId mismatch | Omit or set actual model id |
See Capability errors.