1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
直接绑定设备和家庭
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DirectBindDeviceInFamily。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, eu-frankfurt, na-ashburn 。 |
IotAppID | 是 | String | 小程序appid 示例值:sdfsdf |
UserID | 是 | String | 用户ID 示例值:234234234 |
FamilyId | 是 | String | 家庭ID 示例值:dsfsdf |
ProductId | 是 | String | 产品ID 示例值:sdffsdf |
DeviceName | 是 | String | 设备名 示例值:sdfsd |
RoomId | 否 | String | 房间ID 示例值:2 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AppDeviceInfo | AppDeviceInfo | 返回设备信息 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 直接绑定设备
输入示例
https://iotexplorer.tencentcloudapi.com/?Action=DirectBindDeviceInFamily
&IotAppID=ABCDE12345
&UserID=dev_49
&FamilyId=0
&ProductId=1
&DeviceName=tt
&RoomId=1
&<公共请求参数>
输出示例
{
"Response": {
"AppDeviceInfo": {
"DeviceId": "FPEU28BCGP/dev1",
"ProductId": "FPEU28BCGP",
"DeviceName": "dev1",
"AliasName": "t1",
"IconUrl": "",
"FamilyId": "f_cc67fefbcefd43d88a5c0157ee18c975",
"RoomId": "0",
"DeviceType": 0,
"CreateTime": 1630310068,
"UpdateTime": 1630310068
},
"RequestId": "f92406b3-5a9a-4fe8-bc43-45e3d794bb68"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.DBOpertaionError | DB操作错误。 |
InternalError.InternalRPCError | 内部RPC错误。 |
InternalError.InternalServerException | 发生错误。 |
InvalidParameter | 参数错误。 |
ResourceNotFound.DeviceNotExist | 设备不存在。 |
ResourceNotFound.ProductOrDeviceNotExist | 产品或设备不存在。 |
ResourceNotFound.ProductResourceNotExist | 产品资源不存在。 |
ResourceNotFound.StudioProductNotExist | 产品不存在。 |
UnauthorizedOperation.APPNoPermissionToStudioProduct | APP对产品没有权限。 |
UnauthorizedOperation.AppNoPermission | App无权限。 |
UnauthorizedOperation.NoPermissionToFamily | 此家庭无权操作。 |
UnauthorizedOperation.NoPermissionToStudioProduct | 产品ACL错误。 |
UnsupportedOperation.CannotReBindFamily | 存在重复的绑定关系。 |
UnsupportedOperation.DeviceType | 设备类型错误。 |