绑定用户分享的设备

最近更新时间:2023-07-14 16:01:46

我的收藏

1. 接口描述

接口请求域名: iot.cloud.tencent.com/api/exploreropen/tokenapi。 本接口(AppBindUserShareDevice)用于绑定用户分享的设备。

2. 输入参数

名称
类型
必选
描述
AccessToken
String
公共参数,AccessToken 用于对一个已经登录的用户鉴权。
RequestId
String
公共参数,唯一请求 ID,可自行生成,推荐使用 uuid。定位问题时,需提供该次请求的 RequestId。
Action
String
公共参数,本接口取值:AppBindUserShareDevice。
ShareDeviceToken
String
设备分享的 Token。
ProductId
String
产品 ID。
DeviceName
String
设备名称。

3. 输出参数

名称
类型
描述
RequestId
String
公共参数,唯一请求ID,与入参相同,定位问题时,需提供该次请求的 RequestId。
Status
String
响应结果。

4. 示例

输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1
content-type: application/json
{
"Action": "AppBindUserShareDevice",
"AccessToken": "8b4a70dd16105f******************18edd4e78a3bb8ec",
"RequestId": "1555507****15",
"ProductId": "22F9Y6II7O",
"DeviceName": "light1",
"ShareDeviceToken": "0820728466424d8f****422ec06bd398"
}
输出示例: 成功
{
"Response": {
"RequestId": "1555507****15",
"Status": "OK"
}
}
输出示例: 失败
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.DeviceBinded",
"Message": "设备已经和当前用户绑定"
},
"RequestId": "1555507****15"
}
}

5. 错误码

错误码
描述
InternalError
内部错误。
InvalidParameterValue
参数取值错误。
InvalidParameterValue.DeviecBinded
设备已经和当前用户绑定。
InvalidParameterValue.UserBindExceedLimit
用户绑定分享设备数已达限制。
InvalidParameterValue.DeviceShareExceedLimit
设备已达最大分享用户数限制。
InvalidParameterValue.CannotBindOwnDevice
不能绑定自己分享的设备。
InvalidParameterValue.ShareDeviceTokenUsed
设备分享 Token 已使用。
InvalidParameterValue.InvalidShareDeviceToken
设备分享 Token 无效。