版本：V4.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說明

參數名	類型	位置	說明
access_group_id	String	Body	權限組ID
access_group_name	String	Body	權限組名稱
access_group_type	String	Body	權限組類型 system：系統 customized：定製
repeat_mode	String	Body	重複模式 never：從不 daily：每日 weekly：每週
start_time	String	Body	開始時間，UTC
finish_time	String	Body	結束時間，UTC
available_days	[]String	Body	可用時間
user_count	Integer	Body	用戶數
created_time	String	Body	創建時間，UTC

請求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

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

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "access_group_name": "test",
      "access_group_id": "arbr2c4b070cc928496198944858b344f",
      "access_group_type": "system",
      "start_time": "00:00:00",
      "finish_time": "23:59:59",
      "repeat_mode": "daily",
      "available_days": [],
      "user_count": 0,
      "created_time": "2024-03-29 08:48:18"
    }
  ]
}

失敗返回示例

見接口失敗返回

獲取權限組信息

接口地址

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
access_group_id	String	Body	是	權限組ID

返回參數

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

result說明

參數名	類型	位置	說明
access_group_name	String	Body	權限組名稱
access_group_type	String	Body	權限組類型 system：系統 customized：定製
devices	[]Object<device>	Body	設備信息
repeat_mode	String	Body	重複模式 never：從不 daily：每日 weekly：每週
available_days	[]String	Body	可用時間
start_time	String	Body	開始時間，UTC
finish_time	String	Body	結束時間，UTC
created_time	String	Body	創建時間，UTC

device說明

參數名	類型	位置	說明
building_id	String	Body	樓棟ID
building_name	String	Body	樓棟名稱
device_id	String	Body	設備ID
device_name	String	Body	設備名稱
mac	String	Body	MAC地址
online	Boolean	Body	判斷設備在離線狀態 true：在線 false：離線
device_type	String	Body	判斷設備類型 Multi-tenants Doorphone：梯口機 Single-tenant Doorphone：門口機 Indoor Monitor：室內機 Guard Phone：管理機 Access Control：門禁
relays	[]Object<relay>	Body	門控信息
security_relays	[]Object<relay>	Body	安全門控信息

relay說明

參數名	類型	位置	說明
relay_name	String	Body	門控名稱
relay_number	String	Body	門控撥號鍵值
relay_id	String	Body	門控ID

請求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_access_group_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_group_id": "arbr2c4b070cc928496198944858b344f",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "access_group_name": "test",
    "access_group_type": "system",
    "start_time": "00:00:00",
    "finish_time": "23:59:59",
    "repeat_mode": "daily",
    "available_days": [],
    "created_time": "2024-03-29 08:48:18",
    "devices": [
      {
        "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
        "device_name": "test",
        "mac": "C10519082089",
        "building_id": "b1a621c1ae77040d697bd2134700f57ee",
        "building_name": "AB01",
        "online": true,
        "device_type": "Multi-tenants Doorphone",
        "security_relays": [],
        "relays": [
          {
            "relay_name": "Front Door 3",
            "relay_number": "#",
            "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2"
          }
        ]
      }
    ]
  }
}

失敗返回示例

見接口失敗返回

獲取權限組設備列表

接口地址

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

返回參數

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

result說明

參數名	類型	位置	說明
building_id	String	Body	樓棟ID
building_name	String	Body	樓棟名稱
device_id	String	Body	設備ID
device_name	String	Body	設備名稱
mac	String	Body	MAC地址
online	Boolean	Body	判斷設備在離線狀態 true：在線 false：離線
device_type	String	Body	判斷設備類型 Multi-tenants Doorphone：梯口機 Single-tenant Doorphone：門口機 Indoor Monitor：室內機 Guard Phone：管理機 Access Control：門禁
relays	[]Object<relay>	Body	門控信息
security_relays	[]Object<relay>	Body	安全門控信息

relay說明

參數名	類型	位置	說明
relay_name	String	Body	門控名稱
relay_number	String	Body	門控撥號鍵值
relay_id	String	Body	門控ID

請求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_access_group_device_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
      "device_name": "test",
      "mac": "C10519082089",
      "building_id": "b1a621c1ae77040d697bd2134700f57ee",
      "building_name": "AB01",
      "online": true,
      "device_type": "Multi-tenants Doorphone",
      "security_relays": [],
      "relays": [
        {
          "relay_name": "Front Door 3",
          "relay_number": "#",
          "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2"
        }
      ]
    }
  ]
}

失敗返回示例

見接口失敗返回

創建權限組信息

接口地址

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
access_group_name	String	Body	是	權限組名稱
devices	[]Object<device>	Body	是	設備信息
repeat_mode	String	Body	是	重複模式 never：從不 daily：每日 weekly：每週
available_days	[]String	Body	否	可用時間
start_time	String	Body	是	開始時間，UTC
finish_time	String	Body	是	結束時間，UTC

device說明

參數名	類型	位置	必填	說明
building_id	String	Body	是	樓棟ID
device_id	String	Body	是	設備ID
mac	String	Body	是	MAC地址
relays	[]Object<relay>	Body	是	門控信息
security_relays	[]Object<relay>	Body	是	安全門控信息

relay說明

參數名	類型	位置	必填	說明
relay_id	String	Body	是	門控ID

返回參數

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

result說明

參數名	類型	位置	說明
access_group_id	String	Body	權限組ID

請求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_access_group_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "access_group_name": "test",
    "start_time": "00:00:00",
    "finish_time": "23:59:59",
    "repeat_mode": "daily",
    "available_days": [],
    "devices": [
      {
        "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
        "mac": "C10519082089",
        "building_id": "b1a621c1ae77040d697bd2134700f57ee",
        "security_relays": [],
        "relays": [
          {
            "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2"
          }
        ]
      }
    ]
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

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

失敗返回示例

見接口失敗返回

更新權限組信息

接口地址

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
access_group_id	String	Body	是	權限組ID
access_group_name	String	Body	是	權限組名稱
devices	[]Object<device>	Body	是	設備信息
repeat_mode	String	Body	是	重複模式 never：從不 daily：每日 weekly：每週
available_days	[]String	Body	否	可用時間
start_time	String	Body	是	開始時間，UTC
finish_time	String	Body	是	結束時間，UTC

device說明

參數名	類型	位置	必填	說明
building_id	String	Body	是	樓棟ID
device_id	String	Body	是	設備ID
mac	String	Body	是	MAC地址
relays	[]Object<relay>	Body	是	門控信息
security_relays	[]Object<relay>	Body	是	安全門控信息

relay說明

參數名	類型	位置	必填	說明
relay_id	String	Body	是	門控ID

返回參數

參數名	類型	位置	說明
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_access_group_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "access_group_id": "a2a621c1ae77040d697bd2134700f57ea",
    "access_group_name": "test",
    "start_time": "00:00:00",
    "finish_time": "23:59:59",
    "repeat_mode": "daily",
    "available_days": [],
    "devices": [
      {
        "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
        "building_id": "b1a621c1ae77040d697bd2134700f57ee",
        "mac": "C10519082089",
        "security_relays": [],
        "relays": [
          {
            "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2"
          }
        ]
      }
    ]
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

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

失敗返回示例

見接口失敗返回

刪除權限組信息

接口地址

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
access_group_id	String	Body	是	權限組ID

返回參數

參數名	類型	位置	說明
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": "delete_access_group_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "access_group_id": "arbr2c4b070cc928496198944858b344f"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

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

失敗返回示例

見接口失敗返回

批量刪除權限組信息

接口地址

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
access_groups	[]Object<access_group>	Body	是	權限組信息

access_group說明

參數名	類型	位置	必填	說明
access_group_id	String	Body	是	權限組ID

返回參數

參數名	類型	位置	說明
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": "batch_delete_access_group_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "access_groups": [
      {
        "access_group_id": "arbr2c4b070cc928496198944858b344f"
      }
    ]
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

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

失敗返回示例

見接口失敗返回

創建權限組賬號信息

接口地址

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
access_group_id	String	Body	是	權限組ID
account_id	String	Body	是	賬號ID
residence_id	String	Body	是	住宅ID

返回參數

參數名	類型	位置	說明
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": "create_access_group_account_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "access_group_id": "arbr2c4b070cc928496198944858b344f",
    "residence_id": "rt1adc223cc4b3bedb6bd4742dedcfa52",
    "account_id": "avbr2c4b070cc928496198944858b34xc"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

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

失敗返回示例

見接口失敗返回

刪除權限組賬號信息

接口地址

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
access_group_id	String	Body	是	權限組ID
residence_id	String	Body	是	住宅ID
building_id	String	Body	是	樓棟ID
account_id	String	Body	是	賬號ID

返回參數

參數名	類型	位置	說明
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": "delete_access_group_account_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "access_group_id": "arbr2c4b070cc928496198944858b344f",
    "residence_id": "rt1adc223cc4b3bedb6bd4742dedcfa52",
    "building_id": "b21adc223cc4b3bedb6bd4742dedcfa52",
    "account_id": "avbr2c4b070cc928496198944858b34xc"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

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

失敗返回示例

見接口失敗返回

獲取權限組列表​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

請求示例​

成功返回示例​

失敗返回示例​

獲取權限組信息​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

device說明​

relay說明​

請求示例​

成功返回示例​

失敗返回示例​

獲取權限組設備列表​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

relay說明​

請求示例​

成功返回示例​

失敗返回示例​

創建權限組信息​

接口地址​

請求參數​

param說明​

device說明​

relay說明​

返回參數​

result說明​

請求示例​

成功返回示例​

失敗返回示例​

更新權限組信息​

接口地址​

請求參數​

param說明​

device說明​

relay說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

刪除權限組信息​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

批量刪除權限組信息​

接口地址​

請求參數​

param說明​

access_group說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

創建權限組賬號信息​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

刪除權限組賬號信息​

接口地址​

請求參數​

param說明​

獲取權限組列表

接口地址

請求參數

param說明

返回參數

result說明

請求示例

成功返回示例

失敗返回示例

獲取權限組信息

接口地址

請求參數

param說明

返回參數

result說明

device說明

relay說明

請求示例

成功返回示例

失敗返回示例

獲取權限組設備列表

接口地址

請求參數

param說明

返回參數

result說明

relay說明

請求示例

成功返回示例

失敗返回示例

創建權限組信息

接口地址

請求參數

param說明

device說明

relay說明

返回參數

result說明

請求示例

成功返回示例

失敗返回示例

更新權限組信息

接口地址

請求參數

param說明

device說明

relay說明

返回參數

請求示例

成功返回示例

失敗返回示例

刪除權限組信息

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

批量刪除權限組信息

接口地址

請求參數

param說明

access_group說明

返回參數

請求示例

成功返回示例

失敗返回示例

創建權限組賬號信息

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

刪除權限組賬號信息

接口地址

請求參數

param說明