版本：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说明

参数名	类型	位置	说明
residence_id	String	Body	住宅ID
family_name	String	Body	家庭名称
residence_no	String	Body	住宅号码
building_id	String	Body	楼栋ID
building_name	String	Body	楼栋名称
accounts	[]Object<account>	Body	账号信息
devices	[]Object<device>	Body	设备信息
akuvox_devices	[]Object<akuvox_device>	Body	Akuvox设备信息

account说明

参数名	类型	位置	说明
account_id	String	Body	账号ID
account_name	String	Body	账号名称
first_name	String	Body	名
last_name	String	Body	姓
email	String	Body	邮箱
phone	String	Body	电话
auth	String	Body	账号权限 admin：拥有者，最高管理员 user：家庭管理员用户 guest：家庭普通用户
created_time	String	Body	创建时间，UTC

device说明

参数名	类型	位置	说明
device_id	String	Body	设备ID
device_name	String	Body	设备名称
product_name	String	Body	产品名称
mac	String	Body	MAC地址
space_name	String	Body	空间名称
online	Boolean	Body	判断设备在离线状态 true：在线 false：离线
created_time	String	Body	创建时间，UTC

akuvox_device说明

参数名	类型	位置	说明
device_name	String	Body	设备名称
device_type	String	Body	判断设备类型 Multi-tenants Doorphone：梯口机 Single-tenant Doorphone：门口机 Indoor Monitor：室内机 Guard Phone：管理机 Access Control：门禁
mac	String	Body	MAC地址
online	Boolean	Body	判断设备在离线状态 true：在线 false：离线
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_family_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724721898925,
  "result": [
    {
      "residence_id": "r2c4b070cc928496198944858b344fc68",
      "family_name": "test",
      "residence_no": "101",
      "building_id": "b1a621c1ae77040d697bd2134700f57ee",
      "building_name": "AB01",
      "accounts": [
        {
          "account_id": "a1a621c1ae77040d697bd2134700f57ee",
          "account_name": "test@akubela.com",
          "first_name": "Fly",
          "last_name": "Dom",
          "phone": "1234567",
          "email": "test@akubela.com",
          "created_time": "2024-07-23 17:13:53",
          "auth": "admin"
        }
      ],
      "devices": [
        {
          "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
          "device_name": "HyPanel Pro",
          "product_name": "HyPanel Pro",
          "mac": "B10300240717",
          "space_name": "Living Room",
          "online": true,
          "created_time": "2024-07-17 17:55:30"
        }
      ],
      "akuvox_devices": [
        {
          "device_type": "Multi-tenants Doorphone",
          "device_name": "test",
          "mac": "0CF10532D226",
          "online": true,
          "created_time": "2024-07-17 17:55:31"
        }
      ]
    }
  ]
}

失败返回示例

见接口失败返回

获取家庭信息

接口地址

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
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
family_name	String	Body	家庭名称
residence_no	String	Body	住宅号码
building_id	String	Body	楼栋ID
building_name	String	Body	楼栋名称
call_type	String	Body	呼叫类型 ip：IP呼叫 sip：SIP呼叫
accounts	[]Object<account>	Body	账号信息
devices	[]Object<device>	Body	设备信息
akuvox_devices	[]Object<akuvox_device>	Body	Akuvox设备信息

account说明

参数名	类型	位置	说明
account_id	String	Body	账号ID
account_name	String	Body	账号名称
first_name	String	Body	名
last_name	String	Body	姓
email	String	Body	邮箱
phone	String	Body	电话
auth	String	Body	账号权限 admin：拥有者，最高管理员 user：家庭管理员用户 guest：家庭普通用户
created_time	String	Body	创建时间，UTC

device说明

参数名	类型	位置	说明
device_id	String	Body	设备ID
device_name	String	Body	设备名称
product_name	String	Body	产品名称
mac	String	Body	MAC地址
space_name	String	Body	空间名称
online	Boolean	Body	判断设备在离线状态 true：在线 false：离线
created_time	String	Body	创建时间，UTC

akuvox_device说明

参数名	类型	位置	说明
device_name	String	Body	设备名称
device_type	String	Body	判断设备类型 Multi-tenants Doorphone：梯口机 Single-tenant Doorphone：门口机 Indoor Monitor：室内机 Guard Phone：管理机 Access Control：门禁
mac	String	Body	MAC地址
online	Boolean	Body	判断设备在离线状态 true：在线 false：离线
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_family_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "residence_id": "r2c4b070cc928496198944858b344fc68"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724721898925,
  "result": {
    "family_name": "test",
    "residence_no": "101",
    "building_id": "b1a621c1ae77040d697bd2134700f57ee",
    "building_name": "AB01",
    "call_type": "ip",
    "accounts": [
      {
        "account_id": "a1a621c1ae77040d697bd2134700f57ee",
        "account_name": "test@akubela.com",
        "first_name": "Fly",
        "last_name": "Dom",
        "phone": "1234567",
        "email": "test@akubela.com",
        "created_time": "2024-07-23 17:13:53",
        "auth": "admin"
      }
    ],
    "devices": [
      {
        "device_id": "d28b494e5babb46b288f4baf7fe322cc4",
        "device_name": "HyPanel Pro",
        "product_name": "HyPanel Pro",
        "mac": "B10300240717",
        "space_name": "Living Room",
        "online": true,
        "created_time": "2024-07-17 17:55:30"
      }
    ],
    "akuvox_devices": [
      {
        "device_type": "Multi-tenants Doorphone",
        "device_name": "test",
        "mac": "0CF10532D226",
        "online": true,
        "created_time": "2024-07-17 17:55:31"
      }
    ]
  }
}

失败返回示例

见接口失败返回

获取家庭远程连接

接口地址

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
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
remote_connect_url	String	Body	远程连接地址
online	Boolean	Body	判断家庭在离线状态 true：在线 false：离线

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_family_remote_connect",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "residence_id": "r2c4b070cc928496198944858b344fc68"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724721898925,
  "result": {
    "remote_connect_url": "https://test.my.ecloud.akubela.com",
    "online": true
  }
}

失败返回示例

见接口失败返回

获取家庭列表​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

account说明​

device说明​

akuvox_device说明​

请求示例​

成功返回示例​

失败返回示例​

获取家庭信息​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

account说明​

device说明​

akuvox_device说明​

请求示例​

成功返回示例​

失败返回示例​

获取家庭远程连接​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

获取家庭列表

接口地址

请求参数

param说明

返回参数

result说明

account说明

device说明

akuvox_device说明

请求示例

成功返回示例

失败返回示例

获取家庭信息

接口地址

请求参数

param说明

返回参数

result说明

account说明

device说明

akuvox_device说明

请求示例

成功返回示例

失败返回示例

获取家庭远程连接

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例