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
      • bindDevice: Bind Device
      • unBindDevice: Unbind Device
      • Batch detail by device ID
      • Paged device detail
      • Query online status
      • Pre-bind information
      • Bind state
      • subAccountDeviceInfo
      • subAccountDeviceList
      • setDeviceSnap: Device snapshot
      • setDeviceSnapEnhanced: Device snapshot
      • timeZoneConfigByDay: Set Device Time Zone Daylight Saving Time (by time)
      • timeZoneConfigByWeek: Setting device time zone daylight saving time (per week)
      • timeZoneQueryByDay: Query device time zone daylight saving time (by date)
      • timeZoneQueryByWeek: Obtain device time zone daylight saving time (by week)
    • Device live broadcast
    • Push configuration
    • Cloud storage service
    • Resource pool quota
    • Legacy APIs (deprecated)
  • 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

device.network.get (LAN and connection info)

device.network.get: LAN and connection info

What it does

Returns connection and LAN-related fields for a bound or shared device (public IP, MAC, model, inner IP, and optional encrypted login password). Not listed in device.capability.list. This is a device-query named method, not device.property.* (unlike the network.lan.ipInfo property domain).

Request URL

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

Minimum permission

Device must be bound or shared; otherwise permission denied. Administrator: bound or shared devices. Sub-user: own bound devices. Sub-account: authorized devices.

Request parameters

NameTypeRequiredDefaultValid valuesDescription
tokenStringyesaccessToken
deviceIdStringyesDevice serial number
productIdStringnoOptional. If provided and does not match the device model → DV2009

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

NameTypeDescription
deviceIdStringDevice serial number
productIdStringReturned when known
deviceIpStringPlatform-recorded device IP
macStringMAC address
deviceModelStringDevice model
deviceInnerIpStringLAN IP; empty string when unavailable
devicePasswordStringOptional. V2 ciphertext for device login password (field name devicePassword; same algorithm as the V2 password field on Batch detail by device ID, exposed as devicePasswordV2 in that response, not the passwordV2 rules for Verify password). Omitted when not derivable

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "deviceIp": "1.85.53.219",
 "mac": "FC:B6:9D:39:40:06",
 "deviceModel": "iMX1",
 "deviceInnerIp": "192.168.110.6",
 "devicePassword": "JpsXj/6AvpdsN7td08gB37GNTzDAPlFSRp645ZoxcCl32iqz"
 }
 }
}

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 query (DV20xx)

CodeMeaningNext step
DV2009productId does not match the device modelOmit productId or use the correct model
:---:---:---
DV2010This device cannot complete the operation via this method nowOmit productId and retry
:---:---:---
DV2011No capability permissionSee Permission codes
:---:---:---
DV2012Device not foundCheck serial number
:---:---:---
DV2013Device not boundBind the device first