1. 接口描述
接口请求域名:
iot.cloud.tencent.com/api/exploreropen/tokenapi
。
本接口(AppGetFamilyDeviceList)用于获取用户已绑定设备列表。2. 输入参数
名称 | 类型 | 必选 | 描述 |
AccessToken | String | 是 | 公共参数,AccessToken 用于对一个已经登录的用户鉴权。 |
RequestId | String | 是 | 公共参数,唯一请求 ID,可自行生成,推荐使用 uuId。定位问题时,需提供该次请求的 RequestId。 |
Action | String | 是 | 公共参数,本接口取值:AppGetFamilyDeviceList。 |
FamilyId | String | 是 | 家庭 ID。 |
RoomId | String | 是 | 房间 ID。 |
Offset | Int | 否 | 消息偏移量。 |
Limit | Int | 否 | 最大返回消息条数,最大值为50。 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数,唯一请求 ID,可自行生成,推荐使用 uuId。定位问题时,需提供该次请求的 RequestId。 |
Total | Int | 设备总数。 |
DeviceList | Array |
4. 示例
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"RequestId": "req_1","Action": "AppGetFamilyDeviceList","FamilyId": "e0e23a2b33a24652b6**********a1cf","RoomId": "5", //如果要获取家庭所有设备,则该字段为"","0" 则为默认房间"Offset": 0,"Limit": 2,"AccessToken": "bf******************d098"}
输出实例
{"Response": {"DeviceList": [{"ProductId": "R32*****EU","DeviceName": "df2eSJyY","DeviceId": "R32****0EU/df****yY","AliasName": "df2eSJyY","UserID": "1","RoomId": "r_4b27c753ef774d458e**********86ad","IconUrl": "","CreateTime": 1574664969,"UpdateTime": 1574668779}],"RequestId": "req_1","Total": 1}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误 |
InvalidParameterValue | 参数取值错误 |
InvalidParameterValue.InvalidAccessToken | Token 无效 |