Domain name for API request: tiw.intl.tencentcloudapi.com.
This API is used to query the Tencent Interactive Whiteboard service status of a user, including the activation status and validity period.
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: DescribeUserStatus. |
| Version | Yes | String | Common Params. The value used for this API: 2019-09-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Parameter Name | Type | Description |
|---|---|---|
| AppId | Integer | AppId of the customer. |
| IsTiwUser | Integer | Specifies whether the whiteboard service of the trial or official edition is activated before. 0: The whiteboard service is not activated. 1: The whiteboard service is activated. |
| IsSaaSUser | Integer | Specifies whether the interactive class feature of the trial or official edition is activated before. |
| IsTiwOfflineRecordUser | Integer | Specifies whether the user uses the offline recording feature of the whiteboard service. |
| IsAuthenticated | Integer | Specifies whether the user is authenticated. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
https://tiw.intl.tencentcloudapi.com/?Action=DescribeUserStatus
&<Common request parameters>{
"Response": {
"AppId": 1250000060,
"IsTiwUser": 1,
"IsSaaSUser": 1,
"IsTiwOfflineRecordUser": 1,
"IsAuthenticated": 1,
"RequestId": "9f5a59d6-2b77-41b2-a945-78084577e225"
}
}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 | CAM signature/authentication error. |
| FailedOperation.AlreadyEnabled | Service already activated. |
| InvalidParameter | A parameter error occurred. |
| InvalidParameter.UnmarshalJSONBodyFail | JSON parsing failed, which may be due to parameter type mismatch. |
文档反馈