查询家庭成员列表信息

更新时间：2023-05-22 06:38:13下载pdf

本文介绍查询家庭成员列表信息的 API。

接口描述

用于查询家庭成员列表信息。

接口地址

GET: /v1.0/homes/{home_id}/members

请求参数

参数名	类型	参数位置	是否必填	说明
home_id	Long	uri	true	家庭 ID

返回参数

参数名	类型	说明
result	List	返回结果说明

result 说明

参数名	类型	说明
country_code	String	家庭成员的国家编码
member_account	String	家庭成员的账号
uid	String	家庭成员的用户 ID
admin	Boolean	判断家庭成员是否为管理员 true：是 false：否
name	String	家庭成员的名字
avatar	String	家庭成员的头像
owner	Boolean	判断家庭成员是否为家庭拥有者 true：是 false：否

请求示例

GET: /v1.0/homes/242****/members

返回示例

{
    "result": [
        {
            "admin": true,
            "member_account": "18******176",
            "country_code": "86",
            "uid": "ay1528964101460q****",
            "name": "海拉"
        }
    ],
    "t": 1540799929837,
    "success": true
}

错误码

参考错误码。

上一篇查询家庭下的设备列表

下一篇添加家庭成员