Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
      • Common methods
      • Detection and alarms
      • Image
      • PTZ
      • Light
      • Recording
      • Audio
      • Media
      • Network
        • Cellular
        • LAN
        • Link
        • External services
        • Wi-Fi
          • network.wifi.info (Get Wi-Fi info property)
          • network.wifi.rssi (Get Wi-Fi signal property)
          • network.wifi.rssi (Set Wi-Fi signal property)
          • network.wifi.frequentReport (Get frequent signal report property)
          • network.wifi.frequentReport (Set frequent signal report property)
          • network.wifi.support (Wi-Fi support)
        • Provisioning
        • Gateway
        • Bluetooth
        • Zigbee
      • Power
      • Privacy
      • Call
      • Storage
      • System
      • Algorithm
      • Maintenance
      • Control
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
What it does
Request URL
Minimum permission
Request parameters
Request example
Response data fields
Response example
Error codes

network.wifi.info (Get Wi-Fi info property)

network.wifi.info: Get Wi-Fi info property

network.wifi.info · device scope · permission Config

What it does

Reads the device’s current Wi-Fi information (SSID, connection state, and other detail snapshot fields). Includes sSID, bSSID, status, auth, intensity, isRepeater, and aliasName. intensity inside the struct is signal level 0–4 (1 means no network), which differs from the standalone leaf Get Wi-Fi signal property (network.wifi.rssi, 0–5 including wired) and Get network status property (link overview 0–3): use this page for detail; poll rssi for signal/wired level only; use link.status for link state.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get

Minimum permission

Administrators acting on their own bound devices do not need extra permission. Acting on shared devices requires basic configuration permission. Sub-user binding does not require it. Sub-accounts need Config.

Request parameters

NameTypeRequiredDescription
tokenStringyesAdministrator, sub-user, or sub-account accessToken
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009
propertiesArrayyes["network.wifi.info"]

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",
 "properties": [
 "network.wifi.info"
 ]
 }
}

Response data fields

The value is in result.data.properties["network.wifi.info"].

NameDescriptionTypeRequiredValues
sSIDWi-Fi name.textyesString
bSSIDWi-Fi unique identifier.textyesString
statusConnection state.enumyes0 not connected; 1 connecting; 2 connected
authWi-Fi authentication mode.textyesString
intensitySignal strength.enumyes0 abnormal; 1 no network; 2 poor; 3 fair; 4 good
isRepeaterWhether this is a repeater.intyesInteger
aliasNameRepeater or similar device name.textyesString

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "network.wifi.info": {
 "sSID": "example",
 "bSSID": "example",
 "status": "0",
 "auth": "example",
 "intensity": "0",
 "isRepeater": 1,
 "aliasName": "example"
 }
 }
 }
 }
}

Error codes

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.

CodeMeaningNext step
DV2003Property not on deviceUse device.capability.list
DV2004Value out of rangeCheck properties values
DV2007channelId vs scope mismatchRequired for channel scope; omit for device scope
DV2008Mixed device and channel propertiesSplit the request
DV2009productId mismatchOmit or set actual model id

See Capability errors.

Wi-Fi

network.service.privateStream (Get private streaming service port (default 8086) property)
network.wifi.rssi (Get Wi-Fi signal property)