跳到主要内容
版本:V4.0

家庭管理API


获取家庭列表

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObjectBody命令参数

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
result[]Object<result>Body返回结果

result说明

参数名类型位置说明
account_idStringBody账号ID
residence_idStringBody住宅ID
family_nameStringBody家庭名称
onlineBooleanBody判断家庭在离线状态
true:在线
false:离线
installedBooleanBody判断家庭安装状态
true:安装完成
false:未安装完成

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_family_list",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": [
{
"account_id": "ar58fa9ac8b6a2401bba0828fab548850",
"residence_id": "r8b5a73f8dd84abaa94dcs248be49b0db",
"family_name": "my home",
"online": true,
"installed": true
}
]
}

失败返回示例

接口失败返回



获取家庭信息

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObject<result>Body返回结果

result说明

参数名类型位置说明
family_nameStringBody家庭名称
onlineBooleanBody判断家庭在离线状态
true:在线
false:离线
installedBooleanBody判断家庭安装状态
true:安装完成
false:未安装完成
accounts[]Object<account>Body账号信息

account说明

参数名类型位置说明
account_idStringBody账号ID
account_nameStringBody账号名称
first_nameStringBody
last_nameStringBody
emailStringBody邮箱
authStringBody账号权限
admin:拥有者,最高管理员
user:家庭管理员用户
guest:家庭普通用户

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_family_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {
"family_name": "my home",
"online": true,
"installed": true,
"accounts": [
{
"account_id": "ar58fa9ac8b6a2401bba0828fab548850",
"account_name": "demo@akubela.com",
"first_name": "tom",
"last_name": "fly",
"email": "demo@akubela.com",
"auth": "user"
}
]
}
}

失败返回示例

接口失败返回



更新家庭信息

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID
family_nameStringBody家庭名称

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "update_family_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"family_name": "my home"
}
}

成功返回示例

状态码:200

Content-Type: application/json

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

失败返回示例

接口失败返回



更换家庭主账号

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID
account_idStringBody账号ID

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "change_family_admin",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"account_id": "ar31adc223cc4b3bedb6bd4742dedcfa5"
}
}

成功返回示例

状态码:200

Content-Type: application/json

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

失败返回示例

接口失败返回



邀请家庭账号

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID
emailStringBody邮箱
authStringBody账号权限
user:家庭管理员用户
guest:家庭普通用户

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "invite_family_account",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"email": "demo@akubela.com",
"auth": "user"
}
}

成功返回示例

状态码:200

Content-Type: application/json

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

失败返回示例

接口失败返回



账号加入家庭

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID
authStringBody账号权限
user:家庭管理员用户
guest:家庭普通用户

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "account_join_family",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"auth": "user"
}
}

成功返回示例

状态码:200

Content-Type: application/json

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

失败返回示例

接口失败返回



创建家庭账号

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID
passwordStringBody密码
first_nameStringBody
last_nameStringBody
emailStringBody邮箱
authStringBody账号权限
user:家庭管理员用户
guest:家庭普通用户

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObject<result>Body返回结果

result说明

参数名类型位置说明
account_idStringBody账号ID

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "create_family_account",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"auth": "guest",
"first_name": "tom",
"last_name": "fly",
"email": "demo@akubela.com"
}
}

成功返回示例

状态码:200

Content-Type: application/json

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

失败返回示例

接口失败返回



更新家庭账号权限

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
account_idStringBody账号ID
residence_idStringBody住宅ID
authStringBody账号权限
user:家庭管理员用户
guest:家庭普通用户

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "update_family_account_auth",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"account_id": "ar58fa9ac8b6a2401bba0828fab548850",
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"auth": "guest"
}
}

成功返回示例

状态码:200

Content-Type: application/json

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

失败返回示例

接口失败返回



批量更新家庭账号权限

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID
accounts[]Object<account>Body账号信息

account说明

参数名类型位置必填说明
account_idStringBody账号ID
authStringBody账号权限
user:家庭管理员用户
guest:家庭普通用户

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "batch_update_family_account_auth",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"accounts": [
{
"account_id": "ar58fa9ac8b6a2401bba0828fab548850",
"auth": "guest"
}
]
}
}

成功返回示例

状态码:200

Content-Type: application/json

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

失败返回示例

接口失败返回



删除家庭账号

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
account_idStringBody账号ID
residence_idStringBody住宅ID

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "delete_family_account",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"account_id": "ar58fa9ac8b6a2401bba0828fab548850",
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
}
}

成功返回示例

状态码:200

Content-Type: application/json

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

失败返回示例

接口失败返回



批量删除家庭账号

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID
accounts[]Object<account>Body账号信息

account说明

参数名类型位置必填说明
account_idStringBody账号ID

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "batch_delete_family_account",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"accounts": [
{
"account_id": "ar58fa9ac8b6a2401bba0828fab548850"
}
]
}
}

成功返回示例

状态码:200

Content-Type: application/json

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

失败返回示例

接口失败返回



获取家庭远程连接

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObject<result>Body返回结果

result说明

参数名类型位置说明
remote_connect_urlStringBody远程连接地址
onlineBooleanBody判断家庭在离线状态
true:在线
false:离线

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

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

成功返回示例

状态码:200

Content-Type: application/json

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

失败返回示例

接口失败返回



获取家庭远程协助

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObject<result>Body返回结果

result说明

参数名类型位置说明
usernameStringBody用户名
passwordStringBody密码
start_timeStringBody开始时间,UTC
finish_timeStringBody结束时间,UTC

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_family_remote_assistance",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r2c4b070cc928496198944858b344fc68"
}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1724721898925,
"result": {
"username": "unUAbumT2H",
"password": "pDP6Be8UT3",
"start_time": "2025-01-24 21:10:00",
"finish_time": "2025-01-25 21:10:59"
}
}

失败返回示例

接口失败返回



创建家庭远程协助

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID
start_timeStringBody开始时间,UTC
finish_timeStringBody结束时间,UTC

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObject<result>Body返回结果

result说明

参数名类型位置说明
usernameStringBody用户名
passwordStringBody密码

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "create_family_remote_assistance",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r2c4b070cc928496198944858b344fc68",
"start_time": "2025-01-24 21:10:00",
"finish_time": "2025-01-25 21:10:59"
}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1724721898925,
"result": {
"username": "unUAbumT2H",
"password": "pDP6Be8UT3"
}
}

失败返回示例

接口失败返回



删除家庭远程协助

接口地址

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

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "delete_family_remote_assistance",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r2c4b070cc928496198944858b344fc68"
}
}

成功返回示例

状态码:200

Content-Type: application/json

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

失败返回示例

接口失败返回