查询家庭成员列表信息

更新时间:2024-01-11 05:54:36下载pdf

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

接口描述

根据家庭 ID,查询家庭成员列表信息。

接口地址

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

请求参数

参数名类型参数位置是否必填说明
home_idLonguritrue家庭 ID

返回参数

参数名类型说明
resultList返回结果说明

result 说明

参数名类型说明
country_codeString家庭成员的国家编码
member_accountString家庭成员的账号
uidString家庭成员的用户 ID
adminBoolean判断家庭成员是否为管理员
  • true:是
  • false:否
nameString家庭成员的名字
avatarString家庭成员的头像
ownerBoolean判断家庭成员是否为家庭拥有者
  • true:是
  • false:否

请求示例

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

返回示例

{
    "tid": "b0fd5f777d361*****2c7664ef4d3e193",
    "result": [
        {
            "owner": true,
            "admin": true,
            "avatar": "https://images.tuyacn.com/app/default_avatar/avatar4.png",
            "member_account": "86-*********05",
            "country_code": "86",
            "uid": "ay15913*****0677KZlj2",
            "name": "vt.y"
        }
    ],
    "t": 1699338434674,
    "success": true
}

错误码

参考 错误码