1. API Description
Domain name for API request: trtc.intl.tencentcloudapi.com.
Queries the status of a web-page recording task
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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: DescribeWebRecord. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2019-07-22. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore. |
| TaskId |
No |
String |
The task ID returned when starting web-page recording |
| SdkAppId |
No |
Integer |
SdkAppId passed when initiating web-page recording |
| RecordId |
No |
String |
RecordId passed when initiating recording. When passing this value, you need to pass SdkAppId |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Status |
Integer |
1: Recording |
| TaskId |
String |
Returns when querying using RecordId |
| RecordId |
String |
Returned when querying using TaskId |
| 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. |
4. Example
Example1 Queries the status of a web-page recording task
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWebRecord
<Common request parameters>
{
"TaskId": "HMLm5HWNuUAXSb0gTEOx0z1x+nLMZNjXrY3keyUSvu7uu8mF9O656uNtbUtvaWLkpMY134jTN2Ix4vuqgOJ68nQ8tho3ri"
}
Output Example
{
"Response": {
"Status": 1,
"RequestId": "record_class_1"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| FailedOperation.TaskNotExist |
The task does not exist. |
| InvalidParameter.TaskId |
TaskId parameter error. |