Domain name for API request: tiw.tencentcloudapi.com.
This API is used to query the users of a whiteboard application.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeUserList. |
Version | Yes | String | Common Params. The value used for this API: 2019-09-19. |
Region | No | String | Common Params. This parameter is not required for this API. |
SdkAppId | Yes | Integer | SdkAppId of the whiteboard application. |
RoomId | Yes | String | Room ID to be used to query users. |
TimeRange.N | Yes | Array of Integer | Query period, which consists of two Unix timestamps in milliseconds. The first indicates the start time and the second the end time. |
Query | No | String | Extra query conditions. |
MaxSize | No | Integer | Maximum number of data entries to be returned. Default value: 1000 . |
Parameter Name | Type | Description |
---|---|---|
UserList | Array of UserListItem | User list of the room. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: tiw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserList
<Common request parameters>
{
"SdkAppId": 1400000001,
"RoomId": "0",
"Query": "*",
"MaxSize": 1000,
"TimeRange": [
1614519034000,
1615190492000
]
}
{
"Response": {
"RequestId": "7f560a64-d7fb-476b-89b9-2b90acc5c675",
"UserList": [
{
"UserId": "131001012",
"StartTime": 1614519034000,
"EndTime": 1615190492000
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
AuthFailure | |
FailedOperation | Operation failed. |
UnauthorizedOperation | Unauthorized operation. |
UnauthorizedOperation.SdkAppId | The SdkAppId does not exist or does not match the current Tencent Cloud account. |
本页内容是否解决了您的问题?