版本：V3.0

設備管理API

獲取設備列表

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
page_size	Integer	Body	是	每頁數量
page_index	Integer	Body	是	當前頁數

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	[]Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
residence_id	String	Body	住宅ID
family_name	String	Body	家庭名稱
residence_no	String	Body	住宅號碼
building_id	String	Body	樓棟ID
building_name	String	Body	樓棟名稱
device_id	String	Body	設備ID
device_name	String	Body	設備名稱
mac	String	Body	MAC地址
connected_time	String	Body	連接時間，UTC
first_name	String	Body	名
last_name	String	Body	姓
online	Boolean	Body	判斷設備在離線狀態 true：在線 false：離線
sip	String	Body	SIP號
device_type	String	Body	判斷設備類型 Multi-tenants Doorphone：梯口機 Single-tenant Doorphone：門口機 Indoor Monitor：室內機 Guard Phone：管理機 Access Control：門禁

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_device_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724802057424,
  "result": [
    {
      "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
      "device_name": "test",
      "mac": "C10519082089",
      "connected_time": "2024-01-26 04:59:20",
      "first_name": "Fly",
      "last_name": "Dom",
      "residence_id": "r2c4b070cc928496198944858b344fc68",
      "family_name": "test",
      "residence_no": "101",
      "building_id": "b1a621c1ae77040d697bd2134700f57ee",
      "building_name": "AB01",
      "online": true,
      "sip": "123132312",
      "device_type": "Multi-tenants Doorphone"
    }
  ]
}

失敗返回示例

見接口失敗返回

獲取設備信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
device_id	String	Body	是	設備ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
residence_id	String	Body	住宅ID
family_name	String	Body	家庭名稱
residence_no	String	Body	住宅號碼
building_id	String	Body	樓棟ID
building_name	String	Body	樓棟名稱
device_name	String	Body	設備名稱
mac	String	Body	MAC地址
connected_time	String	Body	連接時間，UTC
first_name	String	Body	名
last_name	String	Body	姓
online	Boolean	Body	判斷設備在離線狀態 true：在線 false：離線
sip	String	Body	SIP號
device_type	String	Body	判斷設備類型 Multi-tenants Doorphone：梯口機 Single-tenant Doorphone：門口機 Indoor Monitor：室內機 Guard Phone：管理機 Access Control：門禁
allow_monitor	Boolean	Body	判斷是否爲允許監控 true：允許 false：不允許
is_public	Boolean	Body	判斷是否爲公共設備 true：是 false：否
relays	[]Object<relay>	Body	門控信息
security_relays	[]Object<relay>	Body	安全門控信息
firmware_version	String	Body	固件版本
hardware_version	String	Body	硬件版本
ip_address	String	Body	IP地址
subnet_mask	String	Body	子網掩碼
gateway	String	Body	網關
primary_dns	String	Body	首選DNS
secondary_dns	String	Body	備選DNS
permission_buildings	[]Object<permission_building>	Body	授權樓棟信息

permission_building說明

參數名	類型	位置	說明
building_id	String	Body	樓棟ID
building_name	String	Body	樓棟名稱

relay說明

參數名	類型	位置	說明
relay_name	String	Body	門控名稱
relay_number	String	Body	門控撥號鍵值
relay_id	String	Body	門控ID
enable	Boolean	Body	判斷是否啓用門控 true：啓用 false：禁用
access_control	Object<access_control>	Body	權限控制
show_home	Boolean	Body	判斷是否展示家庭 true：展示 false：不展示
show_talking	Boolean	Body	判斷是否展示通話 true：展示 false：不展示
schedule	Object<schedule>	Body	日程信息

access_control說明

參數名	類型	位置	說明
enable_pin	Boolean	Body	判斷是否啓用PIN碼 true：啓用 false：禁用
enable_rf_card	Boolean	Body	判斷是否啓用射頻卡 true：啓用 false：禁用
enable_face	Boolean	Body	判斷是否啓用人臉 true：啓用 false：禁用
enable_ble	Boolean	Body	判斷是否啓用藍牙 true：啓用 false：禁用
enable_nfc	Boolean	Body	判斷是否啓用NFC true：啓用 false：禁用

schedule說明

參數名	類型	位置	說明
enable	Boolean	Body	判斷是否啓用日程 true：啓用 false：禁用
access	[]String	Body	權限

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_device_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "device_id": "d131adc223cc4b3bedb6bd4742dedcfa5",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724802105380,
  "result": {
    "device_name": "test",
    "mac": "C10519082089",
    "connected_time": "2024-01-26 04:59:20",
    "first_name": "Fly",
    "last_name": "Dom",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "family_name": "test",
    "residence_no": "101",
    "building_id": "b1a621c1ae77040d697bd2134700f57ee",
    "building_name": "AB01",
    "online": true,
    "sip": "123132312",
    "device_type": "Multi-tenants Doorphone",
    "allow_monitor": true,
    "is_public": true,
    "relays": [
      {
        "relay_name": "Front Door 3",
        "relay_number": "#",
        "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2",
        "enable": true,
        "access_control": {
          "enable_pin": true,
          "enable_rf_card": true,
          "enable_face": true,
          "enable_ble": true,
          "enable_nfc": true
        },
        "show_home": true,
        "show_talking": true,
        "schedule": {
          "enable": false,
          "access": []
        }
      }
    ],
    "security_relays": [],
    "firmware_version": "71.123.37.5",
    "hardware_version": "1.0",
    "ip_address": "192.168.18.171",
    "subnet_mask": "255.255.255.0",
    "gateway": "192.168.18.1",
    "primary_dns": "",
    "secondary_dns": "",
    "permission_buildings": [
      {
        "building_id": "bafa332e258aae1badbb27d31128f442d",
        "building_name": "001"
      }
    ]
  }
}

失敗返回示例

見接口失敗返回

更新設備信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
device_id	String	Body	是	設備ID
device_name	String	Body	是	設備名稱
mac	String	Body	是	MAC地址
allow_monitor	Boolean	Body	是	判斷是否爲允許監控 true：允許 false：不允許
relays	[]Object<relay>	Body	否	門控信息
security_relays	[]Object<relay>	Body	否	安全門控信息

relay說明

參數名	類型	位置	必填	說明
relay_name	String	Body	是	門控名稱
relay_number	String	Body	是	門控撥號鍵值
relay_id	String	Body	是	門控ID
enable	Boolean	Body	是	判斷是否啓用門控 true：啓用 false：禁用
access_control	Object<access_control>	Body	是	權限控制
show_home	Boolean	Body	是	判斷是否展示家庭 true：展示 false：不展示
show_talking	Boolean	Body	是	判斷是否展示通話 true：展示 false：不展示
schedule	Object<schedule>	Body	是	日程信息

access_control說明

參數名	類型	位置	必填	說明
enable_pin	Boolean	Body	是	判斷是否啓用PIN碼 true：啓用 false：禁用
enable_rf_card	Boolean	Body	是	判斷是否啓用射頻卡 true：啓用 false：禁用
enable_face	Boolean	Body	是	判斷是否啓用人臉 true：啓用 false：禁用
enable_ble	Boolean	Body	是	判斷是否啓用藍牙 true：啓用 false：禁用
enable_nfc	Boolean	Body	是	判斷是否啓用NFC true：啓用 false：禁用

schedule說明

參數名	類型	位置	必填	說明
enable	Boolean	Body	是	判斷是否啓用日程 true：啓用 false：禁用
access	[]String	Body	是	權限

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_device_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa22",
    "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
    "mac": "C10519082089",
    "device_name": "test",
    "allow_monitor": true,
    "relays": [
      {
        "relay_name": "Front Door 3",
        "relay_number": "#",
        "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2",
        "enable": true,
        "access_control": {
          "enable_pin": true,
          "enable_rf_card": true,
          "enable_face": true,
          "enable_ble": true,
          "enable_nfc": true
        },
        "show_home": true,
        "show_talking": true,
        "schedule": {
          "enable": false,
          "access": []
        }
      }
    ],
    "security_relays": []
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

獲取設備列表​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

請求示例​

成功返回示例​

失敗返回示例​

獲取設備信息​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

permission_building說明​

relay說明​

access_control說明​

schedule說明​

請求示例​

成功返回示例​

失敗返回示例​

更新設備信息​

接口地址​

請求參數​

param說明​

relay說明​

access_control說明​

schedule說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

獲取設備列表

接口地址

請求參數

param說明

返回參數

result說明

請求示例

成功返回示例

失敗返回示例

獲取設備信息

接口地址

請求參數

param說明

返回參數

result說明

permission_building說明

relay說明

access_control說明

schedule說明

請求示例

成功返回示例

失敗返回示例

更新設備信息

接口地址

請求參數

param說明

relay說明

access_control說明

schedule說明

返回參數

請求示例

成功返回示例

失敗返回示例