1. 接口描述
接口请求域名：
iot.cloud.tencent.com/api/exploreropen/tokenapi。
本接口（AppDescribeFamily）用于获取家庭详情。2. 输入参数
名称 | 类型 | 必选 | 描述 |
AccessToken | String | 是 | 公共参数，AccessToken 用于对一个已经登录的用户鉴权。 |
RequestId | String | 是 | 公共参数，唯一请求 ID，可自行生成，推荐使用 uuid。定位问题时，需提供该次请求的 RequestId。 |
Action | String | 是 | 公共参数，本接口取值：AppDescribeFamily。 |
FamilyId | String | 是 | 所需查询详情的家庭 ID。 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数，唯一请求 ID，与入参相同，定位问题时，需提供该次请求的 RequestId。 |
FamilyId | String | 家庭 ID。 |
FamilyName | String | 家庭名称。 |
Address | String | 家庭地址。 |
CreateTime | Int64 | 创建时间，UNIX 时间戳（秒级）。 |
UpdateTime | Int64 | 最后一次更新时间，UNIX 时间戳（秒级）。 |
4. 示例
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"RequestId": "req_1","Action": "AppDescribeFamily","FamilyId": "a1c6939b39d345b897b168313f8ca12c","AccessToken": "c1******************847e"}
输出示例：成功
{"Response": {"RequestId": "req_1","Data": {"FamilyId": "a1c6939b39d345b897b168313f8ca12c","FamilyName": "family_name","Address": "family_address","CreateTime": 1570786578,"UpdateTime": 1570790807}}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidAccessToken | Token 无效。 |