帮你快速理解、总结文档立即下载

获取设备分享 Token

最近更新时间:2024-10-11 16:01:45
我的收藏

1. 接口描述

接口请求域名: iot.cloud.tencent.com/api/exploreropen/tokenapi。 本接口(AppCreateShareDeviceToken)用于获取设备分享 Token。

2. 输入参数

名称
类型
必选
描述
AccessToken
String
是
公共参数,AccessToken 用于对一个已经登录的用户鉴权。
RequestId
String
是
公共参数,唯一请求 ID,可自行生成,推荐使用 uuid。定位问题时,需提供该次请求的 RequestId。
Action
String
是
公共参数,本接口取值:AppCreateShareDeviceToken。
FamilyId
String
是
家庭 ID,成功创建家庭后,返回的 FamilyId
ProductId
String
是
产品 ID。
DeviceName
String
是
设备名称。
TokenContext
String
否
分享的上下文。

3. 输出参数

名称
类型
描述
RequestId
String
公共参数,唯一请求 ID,与入参相同,定位问题时,需提供该次请求的 RequestId。
ShareDeviceToken
String
设备分享 Token。

4. 示例

输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1
content-type: application/json
{
"Action": "AppCreateShareDeviceToken",
"AccessToken": "8b4a70dd16105f******************18edd4e78a3bb8ec",
"RequestId": "155550****15",
"ProductId": "22F9****7O",
"DeviceName": "light1"
}
输出示例: 成功
{
"Response": {
"RequestId": "1555507****15",
"ShareDeviceToken": "49d2b71dc5814****7c68a4c756d3ce9"
}
}
输出示例: 失败
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.InvalidAccessToken",
"Message": "Token无效"
},
"RequestId": "1555507****15"
}
}

5. 错误码

错误码
描述
InternalError
内部错误。
InvalidParameterValue
参数取值错误。
InvalidParameterValue.InvalidAccessToken
Token 无效。
InvalidParameterValue.NoPermission
用户对该设备无权限。