1. API Description
Domain name for API request: trtc.intl.tencentcloudapi.com.
This interface can be used to initiate a web-page recording task. In the interface parameters, specify the recording URL, recording resolution, recording result storage and other parameters. If there are parameter or API logic problems, the result will be returned immediately. If there are page problems, such as the page cannot be accessed, the result will be returned in the callback. Please pay attention.
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: StartWebRecord. |
| 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. |
| RecordUrl |
Yes |
String |
URL of the web page to be recorded |
| MaxDurationLimit |
No |
Integer |
Maximum recording duration limit, in seconds. Valid range: [1800, 36000]. Default is 36,000 seconds (10 hours). |
| StorageParams |
No |
StorageParams |
[Required] Parameters related to cloud storage. Currently, Tencent Cloud Object Storage and Tencent Cloud VOD are supported, but third-party cloud storage is not supported. The storage format of the output file only supports hls or mp4. |
| WebRecordVideoParams |
No |
WebRecordVideoParams |
web-page recording video parameters |
| SdkAppId |
No |
Integer |
[Required] The SDKAppID of the TRTC room |
| RecordId |
No |
String |
When sensitive to repetitive tasks, please pay attention to this value: To avoid tasks being initiated repeatedly in a short period, leading to task duplication, pass in the recording RecordId to identify the current task. The RecordId should be less than 32 bytes. If you carry the RecordId and initiate the start recording request more than once, only one task will be started, and the second one will report the error FailedOperation.TaskExist. Note that if the StartWebRecord call fails with an error other than FailedOperation.TaskExist, please change the RecordId and initiate the request again. |
| PublishCdnParams.N |
No |
Array of McuPublishCdnParam |
If you want to push the stream to a CDN, you can use the PublishCdnParams.N parameter to set it. It supports pushing streams to up to 10 CDN addresses simultaneously. If the relay address is a Tencent Cloud CDN, please explicitly set IsTencentCdn to 1. |
| ReadyTimeout |
No |
Integer |
The timeout for loading page resources during recording, in seconds. The default value is 0 seconds. This value must be greater than or equal to 0 seconds and less than or equal to 60 seconds. If page load timeout detection is not enabled for the recording page, please do not set this parameter. |
| EmulateMobileParams |
No |
EmulateMobileParams |
Render mobile mode parameters; do not set this parameter if you are not going to render mobile mode pages. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| TaskId |
String |
The unique ID of the recording task |
| 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 Starts an web-page recording task
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartWebRecord
<Common request parameters>
{
"RecordUrl": "https://web-record-xxxxx.cos.ap-xxx.myqcloud.com/xxxx/xxx.mp4",
"StorageParams": {
"CloudStorage": {
"Vendor": 0,
"Bucket": "webrecord-1234589",
"Region": "ap-singapore",
"AccessKey": "AKxxxxxx",
"SecretKey": "Idxxxxxx",
"FileNamePrefix": [
"record",
"video"
]
}
},
"MaxDurationLimit": 3600,
"WebRecordVideoParams": {
"Width": 1280,
"Height": 720,
"Format": "mp4"
}
}
Output Example
{
"Response": {
"TaskId": "HMLm5HWNuUAXSb0gTEOx0z1x+nLMZNjXrY3keyUSvu7uu8mF9O656uNtbUtvaWLkpMY134jTN2Ix4vuqgOJ68nQ8tho3ri",
"RequestId": "2a76ee73-6579-42f0-8d57-1f6c9b9d7208"
}
}
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.NotAbility |
Need to unlock the required ability |
| FailedOperation.NotAllowed |
This operation is not allowed, please submit a ticket to contact us |
| FailedOperation.SdkAppIdNotUnderAppId |
There is no resource for this SdkAppId In this AppId |
| FailedOperation.TaskExist |
Task already exists |
| ResourceInsufficient.RequestRejection |
Insufficient resources. |