创建云端切片任务

最近更新时间:2025-07-18 01:48:44

我的收藏

1. 接口描述

接口请求域名: trtc.tencentcloudapi.com 。

接口说明:
启动云端切片功能,完成房间内的音视频切片,并上传到指定的云存储。

您可以通过此接口实现如下目标:

  • 指定切片参数(SliceParams)来指定需要切片的主播的黑名单或者白名单。
  • 指定存储参数(SliceStorageParams)来指定上传到您希望的云存储,目前支持腾讯云(对象存储COS)和第三方AWS

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCloudSliceTask。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。
SdkAppId Integer TRTC的SdkAppId,和TRTC的房间所对应的SdkAppId相同。
示例值:1400704311
RoomId String TRTC的RoomId,为TRTC房间所对应的RoomId。
示例值:295212
UserId String 机器人的UserId,用于进房发起切片任务。【*注意】这个UserId不能与当前房间内的主播观众UserId重复。如果一个房间发起多个切片任务时,机器人的userid也不能相互重复,否则会中断前一个切片任务。建议可以把房间ID作为UserId的标识的一部分,即机器人UserId在房间内唯一。
示例值:slice_robot_1
UserSig String 机器人UserId对应的校验签名,即UserId和UserSig相当于机器人进房的登录密码,具体计算方法请参考TRTC计算UserSig的方案。
示例值:eJyrVgrxCdYrSy1SslIy0jNQ0gHzM1NS80oy0zLBwpl5xQWpySVQqeKU7MSCgswUJSsjAwNDAwsDM4h4axxx
SliceParams SliceParams 云端切片控制参数。
SliceStorageParams SliceStorageParams 云端切片文件上传到云存储的参数
RoomIdType Integer TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId(默认) 示例值:1
示例值:1
ResourceExpiredHour Integer 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。 示例值:24
示例值:24
PrivateMapKey String TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。 示例值:eJw1jcEKgkAURX9FZlvY****fL9rfNX4_

3. 输出参数

参数名称 类型 描述
TaskId String 云端切片服务分配的任务ID。任务ID是对一次切片任务生命周期过程的唯一标识,结束任务时会失去意义。任务ID需要业务保存下来,作为下次针对这个任务操作的参数
示例值:-npVqpdU7pr3JUbUasDy5PLPQaHPhkPbIkDILoK-2OqyoZWQndibCtH88ztBhkWAhZCH9DwE.
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建切片任务

启动SdkAppId 为 200806 指定房间(房间号为150)的云端切片任务。

房间空闲等待时间设置为30秒。
切片模式设置为音频切片+视频截帧
音频隔15秒切片一次
视频隔5秒,截帧一次

输入示例

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudSliceTask
<公共请求参数>

{
    "SdkAppId": 200806,
    "RoomId": "150",
    "UserId": "inspect",
    "UserSig": "eJxxxv3xY6jx2KgRU1NPHMy3CnQIZEJBDxf1SulLZcs*pAAuveqIuFaeqrW2kMVyAFYogrTGbnBiScDmm2zf0*HdqoLAhxQ85dn4vMn4*N8zFT7f-aXIf3Zj0fWn78*ktBUUyJoEmHMS0ChM83AAD---1NMfA_",
    "SliceParams": {
        "SliceType": 3,
        "MaxIdleTime": 30,
        "SliceAudio": 15,
        "SliceVideo": 5
    },
    "SliceStorageParams": {
        "CloudSliceStorage": {
            "Vendor": 0,
            "Region": "ap-guangzhou",
            "Bucket": "av-recover-prod-1258344699",
            "AccessKey": "AKIDiGYZYrugBPM3TbS2MO9dqxxx",
            "SecretKey": "91w4wXswiDSQ7XfX8So31xxx",
            "FileNamePrefix": [
                "prefix1"
            ]
        }
    },
    "RoomIdType": 1,
    "ResourceExpiredHour": 72
}

输出示例

{
    "Response": {
        "RequestId": "6c8eac0c-a46e-4002-893a-935160b43b34",
        "TaskId": "-npVqpdU7qidKD61us+k9KlbamMCLrDbczWnLoK-2OqyoZWQndib8Ma8fbGq2JxnW26LgE."
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnRealNameAuthenticated 未完成实名认证,不允许此操作。
AuthFailure.UnauthorizedOperation CAM鉴权失败。
AuthFailure.UnsupportedOperation 不支持该操作。
FailedOperation 操作失败。
FailedOperation.CSUnsupportMethod 云端切片方法不支持。
FailedOperation.RestrictedConcurrency 单用户并发过载,请联系我们增大并发路数到合理值。
InternalError.CSInternalError 云端切片内部服务错误
InvalidParameter.OutOfRange 参数超出范围。
InvalidParameter.SdkAppId SdkAppId参数错误。
MissingParameter.AccessKey 缺少AccessKey参数。
MissingParameter.Bucket 缺少Bucket参数。
MissingParameter.Region 缺少Region参数。
MissingParameter.RoomId 缺少RoomId参数。
MissingParameter.SdkAppId 缺少SdkAppId参数。
MissingParameter.SecretKey 缺少SecretKey参数。
MissingParameter.SliceParams 缺少SliceParams参数。
MissingParameter.SliceStorageParams 缺少SliceStorageParams参数。
MissingParameter.SliceType 缺少SliceType参数。
MissingParameter.TaskId 缺少TaskId参数。
MissingParameter.UserId 缺少UserId参数。
MissingParameter.UserSig 缺少UserSig参数。
MissingParameter.Vendor 缺少Vendor参数。
UnsupportedOperation 操作不支持。