家庭服务

一、应用场景

家庭服务用于存储家庭、房间、设备和终端用户的数据和信息。家庭服务中存在家庭空间的概念，例如家庭或办公室。家庭空间下存在房间的概念，例如客厅、厨房和卧室。房间下可以包含多种品类的设备，例如灯、开关、空调等。在家庭或办公室空间下，可以添加多个成员，共享智能设备的使用。

二、功能说明

家庭服务中，允许用户拥有多个房屋，即用户可管理多个家庭。每一家庭空间下，都拥有对应的管理员、房间和设备：

1. 管理员 - 家庭空间的所有者，可以邀请其他成员加入家庭，共享设备的控制；也可以把家庭成员从家庭中移除。
2. 家庭名称 - 标识家庭空间的标签，例如“我的家”。
3. 房间 - 家庭空间下的元素。
4. 房间名称 - 标识房间的标签，例如“客厅”。
5. 设备 - 家庭空间及房间下的元素，可以是不同品类的设备，例如空调。一个设备最多属于一个家庭，最多属于一个房间。

三、前提条件

1. 已创建对应的家庭
2. 用户必须已经是家庭里的成员

四、流程

无

五、API列表

5.1. 获取家庭信息

接口描述

获取家庭信息

请求方式

GET

请求地址

/v2/home/{home_id}

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	必填	类型	备注
home_id	true	String	家庭ID

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息
id	true	String	家庭ID
name	true	String	家庭名称
type	true	Integer	home的类型,1:管理台创建，2:app创建
creator	true	Integer	创建者
create_time	true	String	创建时间
update_time	false	String	更新时间
version	false	Integer	数据版本号
extend	false	Map	扩展属性
rooms	false	Array	房间列表
rooms.name	false	String	房间名称
rooms.background_url	false	String	背景图
rooms.device_ids	false	Array	设备id列表
rooms.is_default	false	Boolean	是否默认房屋
zones	false	Array	空间列表
zones.id	false	String	空间ID
zones.name	false	String	空间名称
zones.room_ids	false	Array	空间的房间ids
full_name	false	String	空间全称（由主数据提供）
user_list	false	Array	成员列表
user_list.user_id	false	String	用户ID
user_list.role	false	String	角色类型
user_list.expire_time	false	String	到期时间
user_list.nickname	false	Boolean	是否能控制全部设备
user_list.house_role	false	Integer	成员在房屋中对应的类型 1：业主；2：亲属；3：租客；99：安装工；98：验收人员
user_list.phone	false	String	手机号码
user_list.email	false	String	邮箱
user_list.remark	false	false	备注

返回示例：

{
	"status": 200,
	"msg": "ok",
	"code": 200,
    "data": {
      	"id":"sda6a8d92e10d0da0sd"，
        "name":"1001",
        "full_name":"xxaxx-xxx-xxx-xx-1001"
        "type":1,
        "creator":"sad68dq99",
        "create_time":"2021-09-23T09:29:39.250+0000",
        "update_time":"2021-09-23T09:29:39.250+0000",
        "version":"1.0.0",
        "extend":{
        	"xxx":"aaaa"
    	},
        "rooms":[
        	{
        		"name":"xxxx",
        		"background_url":"xxxxxxxxxxxxx",
        		"device_ids":[132114223,642551242],
        		"is_default":true
    		}
    	],
        "zones":[
            {
                "id":"nvfu9f1rjf212",
                "name":"xxxx",
                "room_ids":[
                    "suvq86wqd81922"
                ]
            }
        ],
    	"user_list":[
         	{
                "user_id":23123321;
                "role":1,
                "expire_time":"2021-09-23T09:29:39.250+0000",
                "nickname":"acascsa",
                "house_role":1,
                "phone":"18829312739",
                "email":"xxxxsadasa@xlink.com",
                "remark":"xxxxxxx"
            }   
        ]
    }
}

错误码：

错误码	描述
4041035	home的成员不存在

5.2. 获取家庭列表

接口描述

获取家庭列表

请求方式

GET

请求地址

/v2/homes?user_id=xxxxx

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
user_id	query	true	Integer	用户ID

返回参数说明

名称	必填	类型	备注
code	false	String	成功、错误码
msg	false	String	对于返回值的详细说明
count	True	string	数据总数
list	True	Array	数据列表
list.id	True	String	家庭ID
list.name	True	String	家庭名称
list.type	True	Integer	home的类型,1:管理台创建，2:app创建
list.creator	True	Integer	创建者
list.create_time	True	String	创建时间
list.update_time	false	String	更新时间
list.version	false	Integer	数据版本号
list.extend	false	Map	扩展属性
list.rooms	false	Array	房间列表
list.rooms.name	false	String	房间名称
list.rooms.background_url	false	String	背景图
list.rooms.device_ids	false	Array	设备id列表
list.rooms.is_default	false	Boolean	是否默认房屋
list.zones	false	Array	空间列表
list.zones.id	false	String	空间ID
list.zones.name	false	String	空间名称
list.zones.room_ids	false	Array	空间的房间ids
list.full_name	false	String	空间全称（由主数据提供）
list.user_list	false	Array	成员列表
list.user_list.user_id	false	String	用户ID
list.user_list.role	false	String	角色类型
list.user_list.expire_time	false	String	到期时间
list.user_list.nickname	false	Boolean	是否能控制全部设备
list.user_list.house_role	false	Integer	成员在房屋中对应的类型 1：业主；2：亲属；3：租客；99：安装工；98：验收人员
list.user_list.phone	false	String	手机号码
list.user_list.email	false	String	邮箱
list.user_list.remark	false	false	备注

返回示例：

{
        "count":1,
        "list":[
             {
                "id":"sda6a8d92e10d0da0sd"，
                "name":"1001",
                "full_name":"xxaxx-xxx-xxx-xx-1001"
                "type":1,
                "creator":21421321,
                "create_time":"2021-09-23T09:29:39.250+0000",
                "update_time":"2021-09-23T09:29:39.250+0000",
                "version":"1.0.0",
                "extend":{
                    "xxx":"aaaa"
                },
                "rooms":[
                    {
                        "name":"xxxx",
                        "background_url":"xxxxxxxxxxxxx",
                        "device_ids":[132114223,642551242],
                        "is_default":true
                    }
                ],
                "zones":[
                    {
                        "id":"nvfu9f1rjf212",
                        "name":"xxxx",
                        "room_ids":[
                            "suvq86wqd81922"
                        ]
                    }
                ],
                "user_list":[
                    {
                        "user_id":23123321;
                        "role":1,
                        "expire_time":"2021-09-23T09:29:39.250+0000",
                        "nickname":"acascsa",
                        "house_role":1,
                        "phone":"18829312739",
                        "email":"xxxxsadasa@xlink.com",
                        "remark":"xxxxxxx"
                    }   
                ]
            }
		]
	}

错误码：

错误码	描述
4001001	请求数据字段验证不通过

5.3. 创建家庭

接口描述

用户取消自己提交的房产审核

请求方式

POST

请求地址

/v2/home_server/home

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
name	body	true	string	家庭名称
default_room	body	false	boolean	是否创建默认房间

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息
data	false	Object	返回数据
id	true	String	ID
type	true	Integert	home的类型,1:管理台创建，2:app创建
name	true	String	家庭名称
user_id	false	Integert	创建用户id
role	false	Integert	家庭角色 1：超级管理员；2：管理员；3：普通成员；4：访客；99：安装工
expire_time	false	Date	过期时间
user_list	false	Array	用户列表
user_list.user_id	false	String	用户ID
user_list.role	false	String	角色类型
user_list.expire_time	false	String	到期时间
user_list.nickname	false	Boolean	是否能控制全部设备
user_list.house_role	false	Integer	成员在房屋中对应的类型 1：业主；2：亲属；3：租客；99：安装工；98：验收人员
user_list.phone	false	String	手机号码
user_list.email	false	String	邮箱
user_list.remark	false	false	备注
creator	false	Integer	创建人
create_time	true	Date	创建时间
update_time	false	Date	更新时间
version	false	String	版本

返回示例：

{
    "id":"sda6a8d92e10d0da0sd"，
    "name":"1001",
    "type":2,
    "creator":1111213,
    "create_time":"2021-09-23T09:29:39.250+0000",
    "version":"1.0.0",
    "user_list":[
    	{
            "user_id":23123321;
            "role":1,
            "expire_time":"2021-09-23T09:29:39.250+0000",
            "nickname":"acascsa",
            "house_role":1,
            "phone":"18829312739",
            "email":"xxxxsadasa@xlink.com",
            "remark":"xxxxxxx"
		}   
	]
}

错误码：

错误码	描述
4001200	房间数超出限制

5.4. 根据家庭标识修改家庭名称

接口描述

根据家庭标识修改家庭名称

请求方式

PUT

请求地址

/v2/home/{home_id}

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
home_id	path	true	String	家庭ID
name	body	true	string	家庭名称

请求示例：

{
	"name": "lht0001",
}

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息

返回示例：

{
    
}

错误码：

错误码	描述
4001002	请求数据必须字段不可为空
4001001	请求数据字段验证不通过
4041035	家庭的成员不存在
4031014	需要家庭的管理员及以上的权限
4031016	家庭成员到期

5.5. 根据家庭标识删除家庭

接口描述

根据家庭标识删除家庭

请求方式

DELETE

请求地址

/v2/home/{home_id}

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
home_id	path	true	String	家庭ID

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息

返回示例：

{
    
}

错误码：

错误码	描述
4031015	需要家庭的创建者权限
4041036	家庭不存在
4031024	权限不足, 包括成员大客户经销商

5.6. 创建房间

接口描述

创建房间

请求方式

POST

请求地址

/v2/home/{home_id}/room

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
home_id	path	true	String	家庭ID
name	body	true	String	房间名称
background_url	body	false	String	背景图片

请求示例：

{
	"name":"我的房间",
    "background_url": "www.xxxxxxxx.png"
}

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息
id	false	String	房间ID
name	false	String	房间名称
background_url	false	String	背景图片

返回示例：

{
    "id": "21h21l21"
	"name":"我的房间",
    "background_url": "www.xxxxxxxx.png"
}

错误码：

错误码	描述
4001001	请求数据字段验证不通过
4001002	请求数据必须字段不可为空
4041036	家庭不存在

5.7. 修改房间

接口描述

修改房间

请求方式

PUT

请求地址

/v2/home/{home_id}/room/{room_id}

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
home_id	path	true	String	家庭ID
room_id	path	true	String	房间ID
name	body	false	String	房间名称
background_url	body	false	String	背景图片

请求示例：

{
	"name":"我的房间",
    "background_url": "www.xxxxxxxx.png"
}

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息
id	false	String	房间ID
name	false	String	房间名称
background_url	false	String	背景图片

返回示例：

{
    "id": "21h21l21"
	"name":"我的房间",
    "background_url": "www.xxxxxxxx.png"
}

错误码：

错误码	描述
4001001	请求数据字段验证不通过
4001002	请求数据必须字段不可为空
4041036	家庭不存在
4041052	房间不存在
4001385	默认房间不能更新

5.8. 删除房间

接口描述

删除房间

请求方式

DELETE

请求地址

/v2/home/{home_id}/room/{room_id}

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
home_id	path	true	String	家庭ID
room_id	path	true	String	房间ID

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息

返回示例：

{
    
}

错误码：

错误码	描述
4041036	家庭不存在
4041052	房间不存在
4031024	权限不足, 包括成员大客户经销商
4001385	默认房间不能更新

5.9. 房间添加一个设备

接口描述

房间添加一个设备

请求方式

POST

请求地址

/v2/home/{home_id}/room/{room_id}/device_add

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
home_id	path	true	String	家庭ID
room_id	path	true	String	房间ID
device_id	body	true	Integer	设备ID

请求示例：

{
	"device_id": 23781236
}

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息

返回示例：

{
  
}

错误码：

错误码	描述
4041036	家庭不存在
4041052	房间不存在
4001140	设备不属于家庭

5.10. 房间移除一个设备

接口描述

房间移除一个设备

请求方式

POST

请求地址

/v2/home/{home_id}/room/{room_id}/device_remove

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
home_id	path	true	String	家庭ID
room_id	path	true	String	房间ID
device_id	body	true	Integer	设备ID

请求示例：

{
	"device_id": 23781236
}

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息

返回示例：

{
  
}

错误码：

错误码	描述
4041036	家庭不存在
4041052	房间不存在
4001140	设备不属于家庭
4001384	设备不能从默认房间下移除
4001203	设备不属于房间

5.11. 邀请家庭成员

接口描述

邀请家庭成员

请求方式

POST

请求地址

/v2/home/{home_id}/user_invite

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
home_id	path	true	String	家庭ID
account	body	true	String	用户账号
role	body	true	Integer	角色1：超级管理员；2：管理员；3：普通成员；4：访客；99：安装工
authority	body	false	String	成员对设备的控制 HID：不可见；R：可读；W：可写；RW：可读写
open_id	body	true	String	OpenId
expire_time	body	true	Date	过期时间
source	body	true	Integer	用户来源。 -1（未知）；1（WEB）；2（安卓）；3（IOS）；4（微信）；5（QQ）；6（微博）；7（脸书）；8（推特）；9（短信验证）；10（其它遵循xlink统一身份认证规范的用户来源）；11（支付宝）；12（Apple）
mode	body	true	Integer	家庭邀请记录模式枚举：1：APP内部邀请；2：二维码邀请

请求示例：

{
    "home_id":"df6f01k9726980fgi29f",
    "account":"qq203184719",
    "role":2,
    "authority":"RW",
    "open_id":"d8e10e1eh2109fk",
    "expire_time":"2021-09-23T09:29:39.250+0000",
    "source":2,
    "mode":1
}

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息
invite_id	false	String	邀请ID

返回示例：

{
   "invite_id":"sd87fqf0f1jj901f0f1i"
}

错误码：

错误码	描述
4001001	请求数据字段验证不通过
4001002	请求数据必须字段不可为空
4001343	超级管理员不能被添加
4001008	帐号不合法
4041011	用户不存在
4001243	成员已经存在
4001136	成员数量超过限制

5.12. 用户接受邀请

接口描述

用户接受邀请

请求方式

POST

请求地址

/v2/home/{home_id}/user_accept

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
home_id	path	true	String	家庭ID
invite_id	body	true	String	邀请ID

请求示例：

{  
    "invite_id":"sd87fqf0f1jj901f0f1i"
}

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息

返回示例：

{
   
}

错误码：

错误码	描述
4001130	邀请ID无效
4001134	用户不是邀请者
4001131	邀请的状态错误
4001243	成员已经存在
4001136	成员数量超过限制
4041036	家庭不存在

5.13. 用户拒绝邀请

接口描述

用户拒绝邀请

请求方式

POST

请求地址

/v2/home/{home_id}/user_deny

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
home_id	path	true	String	家庭ID
invite_id	body	true	String	邀请ID

请求示例：

{  
    "invite_id":"sd87fqf0f1jj901f0f1i"
}

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息

返回示例：

{
   
}

错误码：

错误码	描述
4001130	邀请ID无效
4001134	用户不是邀请者
4001131	邀请的状态错误
4001243	成员已经存在

5.14. 家庭成员修改另一个家庭成员的角色

接口描述

家庭成员修改另一个家庭成员的角色

请求方式

PUT

请求地址

/v2/home/{home_id}/user/{user_id}

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	必填	类型	备注
home_id	true	String	家庭ID
user_id	true	Integer	修改的用户ID
role	true	Integer	角色。1：超级管理员；2：管理员；3：普通成员；4：访客；99：安装工
expire_time	false	Date	到期时间

请求示例：

{  
    "role":1,
    "expire_time":"2022-09-23T09:29:39.250+0000"
}

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息

返回示例：

{
   
}

错误码：

错误码	描述
4001343	超级管理员不能被添加
4031024	权限不足, 包括成员大客户经销商
4041036	家庭不存在

5.15. 家庭成员将另一个家庭成员移出家庭

接口描述

家庭成员将另一个家庭成员移出家庭

请求方式

DELETE

请求地址

/v2/home/{home_id}/user/{user_id}

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	必填	类型	备注
home_id	true	String	家庭ID
user_id	true	Integer	修改的用户ID

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息

返回示例：

{
   
}

错误码：

错误码	描述
4001132	超级管理员不能删除
4031024	权限不足, 包括成员大客户经销商
4041036	家庭不存在
4041035	家庭成员不存在

5.16. 家庭添加设备

接口描述

家庭添加设备

请求方式

POST

请求地址

/v2/home/{home_id}/device_add

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	必填	类型	备注
home_id	true	String	家庭ID
device_id	true	Integer	设备ID
authority	true	String	权限 HID：不可见；R：可读；W：可写；RW：可读写
sub_role	true	Integer	子角色 0：管理员；1：用户
add_sub_device	true	Boolean	是否添加子设备

请求示例：

{  
    "device_id": 21832182,
    "authority": "RW"
    "sub_role": 1,
    "add_sub_device": true
}

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息

返回示例：

{
   
}

错误码：

错误码	描述
4041008	设备不存在
4041036	家庭不存在
4001139	不允许多个设备管理员
4001191	设备已经设置了家庭属性

5.17. 家庭移除设备

接口描述

家庭移除设备

请求方式

DELETE

请求地址

/v2/home/{home_id}/device/{device_id}

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	必填	类型	备注
home_id	true	String	家庭ID
device_id	true	Integer	设备ID

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息

返回示例：

{
   
}

错误码：

错误码	描述
4041008	设备不存在
4041036	家庭不存在
4001140	设备不属于home

5.18. 家庭设备列表

接口描述

家庭设备列表

请求方式

GET

请求地址

/v2/home/{home_id}/devices

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	必填	类型	备注
home_id	true	String	家庭ID

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息
count	true	Integer	总数
list	false	Array	列表
list.id	true	Integer	id
list.mac	true	String	MAC地址
list.name	true	String	设备名称
list.is_active	true	Boolean	是否激活
list.active_date	true	Date	激活日期
list.is_online	true	Boolean	是否在线
list.last_login	true	String	最后登陆时间
list.mcu_mod	false	String	MCU型号
list.mcu_version	false	Integer	MCU版本号
list.firmware_mod	false	String	固件型号
list.firmware_version	false	Integer	固件版本号
list.is_gateway	true	Boolean	是否网关设备
list.product_id	true	String	产品ID
list.gateway_id	false	String	网关ID
list.access_key	false	Integer	设备内网访问吗密码
list.role	false	Integer	订阅角色：0：管理员；1：用户
list.authority	false	String	权限 HID：不可见；R：可读；W：可写；RW：可读写
list.source	false	Integer	订阅来源：1：常规扫描，通过CM向设备发起订阅；2：通过其他的用户分享订阅；3：通过二维码订阅,加密产品密钥版本；4：通过家庭产生订阅；5：用户手动添加设备产生的订阅；6：与微信公众号同步产生的订阅；7：云云互联网关；8：通过SN订阅；9：通过订阅码订阅；10：新增来自google的订阅

返回示例：

{
   "count":1,
    "list":[
        {
            "id": 21323414,
            "mac": "XMS5612",
            "name": "设备1",
            "is_active": true,
            "active_date": "2021-09-23T09:29:39.250+0000",
            "is_online": true,
            "last_login": "2022-09-23T09:29:39.250+0000",
            "mcu_mod": "XAS111",
            "mcu_version": 1,
            "firmware_mod": "FFS12",
            "firmware_version": 1,
            "is_gateway": true,
            "product_id": "sd86e213821he812d21d2",
            "gateway_id": 27351782,
            "access_key": 689768,
            "role": 1,
            "authority": "R",
            "source": 4
        }
    ]
}

错误码：

错误码	描述
4041035	家庭成员不存在
4031016	家庭成员到期

5.19. 获取事件消息列表

接口描述

获取事件消息列表

请求方式

POST

请求地址

/v2/homes/event_messages

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
offset	body	False	Integer	开始值
limit	body	False	Integer	限制值
filter	body	False	Array	查询字段
query	body	False	Map<String,Map<String,String>>	查询条件
order	body	False	Map<String,String>	排序

请求示例：

{  
    "offset": 0,
    "limit": 1,
    "query": {"id":{"$eq":"hwd8hd9u1292hd2121e"}},
    "order": {"create_time": "desc"}        
}

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息
count	true	Integer	总数
list	false	Array	列表
list.id	true	String	id
list.home_id	true	String	家庭ID
list.read	true	Boolean	是否已读
list.type	true	Integer	家庭日志类型
list.title	true	String	消息标题。1：成员通过邀请的方式加入家庭；2：成员拒绝接受邀请；3：用户被移除；4：用户退出；5：管理员权限移交原成员；6：接受管理员权限移交的成员；7：管理员权限移交其他成员；8：家庭移交操作者；9：家庭移交其他成员；10：家庭归还后新成员；11：家庭归还后原有成员；12：成员邀请；13：管理台解散家庭
list.content	true	String	消息内容
list.associate_id	true	Integer
list.status	true	Integer	消息的状态

返回示例：

{
   "count":1,
    "list":[
        {
            "id": "hwd8hd9u1292hd2121e",
            "home_id": "vij293174021n4b1ui49",
            "read": true,
            "type":1,
            "title":"xxx",
            "content":"xxxxx",
            "associate_id":23662315
        }
    ]
}

错误码：

错误码	描述
4001001	请求数据字段验证不通过
4001002	请求数据必须字段不可为空

5.20. 删除家庭事件消息

接口描述

删除事件消息

请求方式

DELETE

请求地址

/v2/homes/event_messages/{id}

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
id	path	true	String	消息ID

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息

返回示例：

{
   
}

错误码：

错误码	描述
4001001	请求数据字段验证不通过
4001002	请求数据必须字段不可为空

5.21. 设置事件消息已读

接口描述

设置事件消息已读

请求方式

POST

请求地址

/v2/homes/event_messages

请求头

名称	必填	类型	备注
Access-Token	true	String	C端用户权限
Content-Type	true	String	application/json

请求参数

名称	位置	必填	类型	备注
read_ids	body	true	Array	消息IDS
read_all	body	true	Boolean	是否全部已读
home_id	body	false	String	家庭ID

请求示例：

{  
	"read_ids":["2e7e190ffu010"],
    "read_all":true,
    "home_id":"vf8vyy99f9jf898fh"
}

返回参数说明

名称	必填	类型	备注
code	false	Integer	错误码
msg	false	String	错误信息

返回示例：

{
 
}

错误码：

错误码	描述
4001001	请求数据字段验证不通过
4001002	请求数据必须字段不可为空

上次更新：2023-02-01