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

查询设备的用户列表

最近更新时间:2025-12-29 15:26:13
我的收藏

1. 接口描述

接口请求域名:iot.cloud.tencent.com/api/exploreropen/tokenapi。 本接口(AppListShareDeviceUsers)用于查询设备用户列表。

2. 输入参数

名称
类型
必选
描述
AccessToken
String
是
公共参数,AccessToken 用于对一个已经登录的用户鉴权。
RequestId
String
是
公共参数,唯一请求 ID,可自行生成,推荐使用 uuid。定位问题时,需提供该次请求的 RequestId。
Action
String
是
公共参数,本接口取值:AppListShareDeviceUsers。
ProductId
String
是
产品 ID。
DeviceName
String
是
设备名称。
Offset
Int
是
分页偏移,0起始,最大不超过500。
Limit
Int
是
单次拉取数量,默认为10,最大不超过100。

3. 输出参数

名称
类型
描述
RequestId
String
公共参数,唯一请求 ID,与入参相同,定位问题时,需提供该次请求的 RequestId。
Total
Int
返回的数据总数。
Users
Array of ShareUserInfo
用户列表。

4. 示例

输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1
content-type: application/json
{
"Action": "AppListShareDeviceUsers",
"AccessToken": "user2",
"RequestId": "1555507****15",
"ProductId": "22F9Y6II7O",
"DeviceName": "light1",
"Offset": 0,
"Limit": 10
}
输出示例: 成功
{
"Response": {
"RequestId": "1555507****15",
"Users": [
{
"UserId": "1",
"CountryCode": "86",
"PhoneNumber": "139****5678",
"NickName": "tests",
"Avatar": "",
"BindTime": 1574153536
}
],
"Total": 1
}
}
输出示例: 失败
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.InvalidAccessToken",
"Message": "Token无效"
},
"RequestId": "1555507****15"
}
}

5. 错误码

错误码
描述
InternalError
内部错误。
InvalidParameterValue
参数取值错误。
InvalidParameterValue.InvalidAccessToken
Token 无效。