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
          • network.link.mode (Get connection mode property)
          • network.link.status (Get network status property)
          • network.link.shared (Get shared link property)
          • network.link.talkFirst (Get shared link talk-first property)
          • network.link.autoSwitch (Get auto network switch property)
          • network.link.autoSwitch (Set auto network switch property)
          • network.link.macs (Get device MAC info property)
          • network.link.switch (Network switch)
          • network.link.oneWay (One-way connection)
          • network.link.lanToWifi (Ethernet to Wi-Fi)
        • External services
        • Wi-Fi
        • 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.link.shared (Get shared link property)

network.link.shared: Get shared link property

network.link.shared · device scope · permission Config

What it does

Reads the device shared link switch. 0 off, 1 on.

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.link.shared"]

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.link.shared"
 ]
 }
}

Response data fields

The value is in result.data.properties["network.link.shared"].

TypeValueDescription
int (JSON number)0Off
int (JSON number)1On

This leaf is an int switch; enum/text leaves in the same domain (e.g. talkFirst) may use different sample types—follow the Type column in the response table.

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "network.link.shared": 0
 }
 }
 }
}

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.

Link

network.link.status (Get network status property)
network.link.talkFirst (Get shared link talk-first property)