1. 接口描述
接口请求域名: trtc.tencentcloudapi.com 。
通过此接口可以发起 WEB 页面录制任务,在接口参数中指定录制 URL,录制分辨率,录制结果存储等参数。
因为参数或API逻辑问题会立即返回结果。而因为页面问题,如页面无法访问,会在回调中返回结果,请关注。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:StartWebRecord。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai 。 |
RecordUrl | 是 | String | 需要录制的网页URL 示例值:https://web-record-xxxx.cos.ap-xxx.xxx.com/test/xxx.mp4 |
MaxDurationLimit | 否 | Integer | 录制最大时长限制, 单位 s, 合法取值范围[1800, 36000], 默认 36000s(10 小时) 示例值:36000 |
StorageParams | 否 | StorageParams | 【必填】云存储相关的参数,目前支持腾讯云对象存储以及腾讯云云点播VOD,不支持第三方云存储;输出文件的存储格式仅支持hls或mp4 |
WebRecordVideoParams | 否 | WebRecordVideoParams | 页面录制视频参数 |
SdkAppId | 否 | Integer | 【必填】TRTC的SdkAppId |
RecordId | 否 | String | 当对重复任务敏感时,请关注此值: 为了避免任务在短时间内重复发起,导致任务重复 传入录制RecordId来标识此次任务, 小于32字节,若携带RecordId发起两次以上的开始录制请求,任务只会启动一个,第二个报错FailedOperation.TaskExist。注意StartWebRecord调用失败时而非FailedOperation.TaskExist错误,请更换RecordId重新发起。 示例值:record_task_abc_1 |
PublishCdnParams.N | 否 | Array of McuPublishCdnParam | 若您想要推流到CDN,可以使用PublishCdnParams.N参数设置,支持最多同时推流到10个CDN地址。若转推地址是腾讯云CDN时,请将IsTencentCdn明确设置为1 |
ReadyTimeout | 否 | Integer | 录制页面资源加载的超时时间,单位:秒。默认值为 0 秒,该值需大于等于 0秒,且小于等于 60秒。录制页面未启用页面加载超时检测时,请勿设置此参数。 示例值:30 |
EmulateMobileParams | 否 | EmulateMobileParams | 渲染移动模式参数;不准备渲染移动模式页面时,请勿设置此参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 录制任务的唯一Id 示例值:Vfn+FlMTUh1hL0a6kfBUPUsd9FmPLyznAsbd+QFsasqLg5UulUlA9JhYTw15YEYMCxXlfQwtl5cNmrbJqFubDTUp3OGPsU. |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 启动一个页面录制任务
输入示例
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartWebRecord
<公共请求参数>
{
"RecordUrl": "https://web-record-xxxxx.cos.ap-xxx.myqcloud.com/xxxx/xxx.mp4",
"StorageParams": {
"CloudStorage": {
"Vendor": 0,
"Bucket": "webrecord-1234589",
"Region": "ap-chengdu",
"AccessKey": "AKxxxxxx",
"SecretKey": "Idxxxxxx",
"FileNamePrefix": [
"record",
"video"
]
}
},
"MaxDurationLimit": 3600,
"WebRecordVideoParams": {
"Width": 1280,
"Height": 720,
"Format": "mp4"
}
}
输出示例
{
"Response": {
"TaskId": "abc",
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.NotAbility | 需要解锁所需能力位 |
FailedOperation.NotAllowed | 不允许此操作,请提交工单联系我们 |
FailedOperation.SdkAppIdNotUnderAppId | AppId下没有此SdkAppId的资源 |
FailedOperation.TaskExist | 任务已存在 |
ResourceInsufficient.RequestRejection | 资源不足。 |