帮你快速理解、总结文档立即下载
文档中心>物联网开发平台>旧版文档>客户端 API>家庭管理>获取家庭成员列表

获取家庭成员列表

最近更新时间：2024-11-01 16:30:32
我的收藏

本页目录：

1. 接口描述

接口请求域名：iot.cloud.tencent.com/api/exploreropen/tokenapi。 本接口（AppGetFamilyMemberList）用于获取家庭成员列表。

2. 输入参数

名称
类型
必选
描述
AccessToken
String
是
公共参数，AccessToken 用于对一个已经登录的用户鉴权。
RequestId
String
是
公共参数，唯一请求 ID，可自行生成，推荐使用 uuid。定位问题时，需提供该次请求的 RequestId。
Action
String
是
公共参数，本接口取值：AppGetFamilyMemberList。
Offset
Int
否
所需要查询的数据的偏移量。
Limit
Int
否
所需要查询的总限制量，最大返回50条。
FamilyId
String
是
需要获取的家庭 ID。

3. 输出参数

名称
类型
描述
RequestId
String
公共参数，唯一请求 ID，与入参相同，定位问题时，需提供该次请求的 RequestId。
Total
Int
返回的家庭成员总数。
MemberList
Array
返回的家庭成员数组，请参见 MemberList。

4. 示例

输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1
content-type: application/json
{
    "FamilyId": "f_b3ac7e6b1cd24392b41e**********5a",
    "Offset": 0,
    "Limit": 100,
    "Action": "AppGetFamilyMemberList",
    "RequestId": "hojkE0Hx88",
    "AccessToken": "3c******************40c5"
}
输出示例：成功
{
    "MemberList": [{
        "UserID": "7267",
        "NickName": "deny",
        "Avatar": "https://wx.qlogo.cn/mmopen/vi_32/V2kIBBE35phMrFKu5sra16bzpUuPtokyWTbMRPt7bRGBjx4fEqQrZxoDYyxNVbtkXMosuxQeIqiafIZJ8ADr8cw/132",
        "Role": 1
    }],
    "Total": 1,
    "RequestId": "hojkE0Hx88"
}

5. 错误码

错误码
描述
InternalError
内部错误。
InvalidParameterValue
参数取值错误。
InvalidParameterValue.InvalidAccessToken
Token 无效。

中国站