The content of this page has been automatically translated by AI. If you encounter any problems while reading, you can view the corresponding content in Chinese.
Help & Documentation>IoT Explorer>Application Side API>Device Sharing>Querying the User-Shared Device List

Querying the User-Shared Device List

Last updated: 2025-04-30 15:37:04

On this page:

1. API Description

api request domain name: iot.cloud.tencent.com/api/exploreropen/tokenapi. This interface (AppListUserShareDevices) is used for querying the device list shared by the user.

2. Input Parameter

Name
Type
Required
Description
AccessToken
String
Yes
Common parameter. AccessToken is used for user authentication of a logged-in user.
RequestId
String
Yes
Common parameter. Unique request ID can be generated manually. It is recommended to use uuid. Locating issues, you need to provide the RequestId for the request.
Action
String
Yes
Common parameter. This interface takes values: AppListUserShareDevices.
Offset
Int
Yes
Pagination offset, starting from 0, maximum not exceeding 500.
Limit
Int
Yes
Pull count per time. Default is 10. Max. 100.

3. Output Parameters

Name
Type
Description
RequestId
String
Common parameter. Unique request ID, same as the input parameter. Locating issues, you need to provide the RequestId for the request.
Total
Int
Total number of returned messages.
ShareDevices
Array of ShareDevices
Respond to device information.

4. Examples

Input example
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1
content-type: application/json
{
  "Action": "AppListUserShareDevices",
  "AccessToken": "8b4a70dd16105f******************18edd4e78a3bb8ec",
  "RequestId": "1555507****15",
  "Offset": 0,
  "Limit": 10
}
Output example: successful
{
  "Response": {
    "RequestId": "1555507****15",
    "ShareDevices": [
      {
        "ProductId": "WTXXXX0MF2",
        "DeviceName": "device_XXXX001",
        "DeviceId": "WTXXXX0MF2/device_XXXX001",
        "AliasName": "test_device",
        "IconUrl": "https://yyy-xxxx-xxx.cos.ap-guangzhou.myqcloud.com/113xxxx7a0b273bxxxxc0b9040feeb/1xxxxxxxxx0.png",
        "CreateTime": "2019-12-17T19:39:21+08:00"
      }
    ],
    "Total": 1
  }
}
Output example: fail
{
  "Response": {
    "Error": {
      "Code": "InvalidParameterValue.InvalidAccessToken",
      "Message": "Invalid Token"
    },
    "RequestId": "1555507****15"
  }
}

5. Error Code

Error Code
Description
InternalError
An internal error occurred.
InvalidParameterValue
Invalid parameter value.
InvalidParameterValue.InvalidAccessToken
The Token is invalid.

中国站 - English