帮你快速理解、总结文档立即下载

创建Agent录制任务

最近更新时间:2026-08-28 01:45:37
我的收藏

1. 接口描述

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

调用该接口,用于创建Agent录制任务。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAgentRecordTask。
Version String 公共参数,本接口取值:2019-06-12。
Region String 公共参数,本接口不需要传递此参数。
LiveRoomUrl String

直播间URL


示例值:https://.**.com/***
MaxDurationMinutes Integer

最长录制时长

单位:分

最长支持720分


示例值:1
StoreCosParam AgentStoreCosParam

文件结果指定存储Cos桶信息。 注意:需开通Cos,创建并授权MPS_QcsRole角色。

StartTime String

定时录制开始时刻

参数格式:2026-07-01T15:31:32+08:00

空表示提交后立即开始录制;非空表示从该时刻开始录制


示例值:2026-07-03T12:10:28.065902+08:00
InterruptPolicy String

中断策略

枚举值:

  • STOP_ON_INTERRUPT: 直播流中断后立即结束录制
  • CONTINUE_UNTIL_END: 直播流中断时忽略中断,继续录制直到任务结束时间

默认值:STOP_ON_INTERRUPT


示例值:CONTINUE_UNTIL_END

3. 输出参数

参数名称 类型 描述
TaskId String

任务创建成功后,返回的任务ID。
调用查询接口,轮询获取任务进度及生成结果。


示例值:task_9fac9a28f27292d8fbdf26e63beaeb03
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 定时开始录制

输入示例

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

{
    "LiveRoomUrl": "https://****.******.com/***********",
    "MaxDurationMinutes": 1,
    "StoreCosParam": {
        "CosBucketName": "******-test-live-record-task-**********",
        "CosBucketRegion": "ap-guangzhou",
        "CosBucketPath": "record-only"
    },
    "StartTime": "2026-07-03T12:10:28.065902+08:00"
}

输出示例

{
    "Response": {
        "TaskId": "task_857a704be0d4da429630928dc35f8b33",
        "RequestId": "7bf98ed1-4e2b-4be6-ab54-ae0f4d1e502d"
    }
}

示例2 立即开始录制

输入示例

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

{
    "LiveRoomUrl": "https://****.******.com/***********",
    "MaxDurationMinutes": 1,
    "StoreCosParam": {
        "CosBucketName": "******-test-live-record-task-**********",
        "CosBucketRegion": "ap-guangzhou",
        "CosBucketPath": "record-only"
    }
}

输出示例

{
    "Response": {
        "TaskId": "task_9fac9a28f27292d8fbdf26e63beaeb03",
        "RequestId": "8a3e4c65-b473-456f-9158-57f3b0a5aff6"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。