1. 接口描述
接口请求域名:
iot.cloud.tencent.com/api/exploreropen/tokenapi
。
本接口(AppGetRoomList)用于获取房间列表。2. 输入参数
名称 | 类型 | 必选 | 描述 |
AccessToken | String | 是 | 公共参数,AccessToken 用于对一个已经登录的用户鉴权。 |
RequestId | String | 是 | 公共参数,唯一请求 ID,可自行生成,推荐使用 uuid。定位问题时,需提供该次请求的 RequestId。 |
Action | String | 是 | 公共参数,本接口取值:AppGetRoomList。 |
Offset | Int | 否 | 所需要查询的数据的偏移量。 |
Limit | Int | 否 | 所需要查询的总限制量,最大返回50条。 |
FamilyId | String | 否 | 需要获取的家庭 ID。 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数,唯一请求 ID,与入参相同,定位问题时,需提供该次请求的 RequestId。 |
Total | Int | 返回的设备总数 |
RoomList | Array |
4. 示例
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"RequestId": "req_1","Action": "AppGetRoomList","FamilyId":"fa070f59a2fe4f1da4**********4fdf","Offset":0,"Limit":2,"AccessToken": "xxx"}
输出示例:成功
{"Response": {"RequestId": "req_1","RoomList": [{"RoomId": "123456","RoomName": "name","DeviceNum": 2,"CreateTime": 1570786578,"UpdateTime": 1570790807}],"Total": 1}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidAccessToken | Token 无效 |