1. 接口描述
接口请求域名：
iot.cloud.tencent.com/api/exploreropen/tokenapi。
本接口（AppGetFamilyList）用于获取家庭列表。2. 输入参数
名称 | 类型 | 必选 | 描述 |
AccessToken | String | 是 | 公共参数，用户通过微信号、手机或邮箱账号登录成功后，获取的访问 Token。 |
RequestId | String | 是 | 公共参数，唯一请求 ID，可自行生成，推荐使用 uuid。定位问题时，需提供该次请求的 RequestId。 |
Action | String | 是 | 公共参数，本接口取值：AppGetFamilyList。 |
Offset | Int | 否 | 所需要查询数据的偏移量。 |
Limit | Int | 否 | 返回条数的限制量，最多为50条。 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数，唯一请求 ID，与入参相同。 |
Total | Int | 返回的家庭数量总数。 |
FamilyList | Array |
4. 示例
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"RequestId": "req_1","Action": "AppGetFamilyList","Offset":0,"Limit":2,"AccessToken": "c1******************847e"}
输出示例：成功
{"Response": {"RequestId": "req_1","FamilyList": [{"FamilyId": "a1c6939b39d345b897b168313f8ca12c","Name": "family_name","Role": 0, // 1:管理员 0：普通成员"CreateTime": 1570786578,"UpdateTime": 1570790807}],"Total":1}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidAccessToken | Token 无效。 |