互动白板
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 互动白板 > 服务端 API > 录制视频生成（内测中）相关接口 > 查询录制视频生成任务

查询录制视频生成任务

最近更新时间：2024-03-12 01:56:25

我的收藏

本页目录：

1. 接口描述

接口请求域名： tiw.tencentcloudapi.com 。

查询录制视频生成任务状态与结果

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeVideoGenerationTask。
Version 是 String 公共参数，本接口取值：2019-09-19。
Region 是 String 公共参数，详见产品支持的 地域列表。
SdkAppId 是 Integer 客户的SdkAppId
TaskId 是 String 录制视频生成的任务Id

3. 输出参数

参数名称 类型 描述
GroupId String 任务对应的群组Id
RoomId Integer 任务对应的房间号
TaskId String 任务的Id
Progress Integer 已废弃
Status String 录制视频生成任务状态
- QUEUED: 正在排队
- PROCESSING: 正在生成视频
- FINISHED: 生成视频结束（成功完成或失败结束，可以通过错误码和错误信息进一步判断）
TotalTime Integer 回放视频总时长,单位：毫秒
VideoInfos VideoInfo 已废弃，请使用VideoInfoList参数
VideoInfoList Array of VideoInfo 录制视频生成视频列表
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询录制视频生成

输入示例

https://tiw.tencentcloudapi.com/?Action=DescribeVideoGenerationTask
&SdkAppId=1400000001
&TaskId=ghucnligqtgtvk2624mb
&<公共请求参数>

输出示例

{
    "Response": {
        "GroupId": "900822",
        "Progress": 100,
        "RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "RoomId": 900822,
        "Status": "FINISHED",
        "TaskId": "00e1jv8ve0jcqk7da9lb",
        "TotalTime": 156750,
        "VideoInfoList": [
            {
                "UserId": "",
                "VideoDuration": 156750,
                "VideoFormat": "mp4",
                "VideoId": "5285890792776509100",
                "VideoPlayTime": 0,
                "VideoSize": 318384,
                "VideoType": 2,
                "Width": 1024,
                "Height": 768,
                "VideoUrl": "http://1257240443.vod2.myqcloud.com/cc35b442vodcq1257240443/video.mp4"
            }
        ],
        "VideoInfos": {
            "VideoType": 0,
            "VideoUrl": "已废弃，请使用VideoInfoList",
            "UserId": "xx",
            "VideoId": "xx",
            "VideoSize": 0,
            "VideoDuration": 0,
            "Width": 0,
            "Height": 0,
            "VideoPlayTime": 0,
            "VideoFormat": "xx"
        }
    }
}

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签名/鉴权错误。
FailedOperation.Record 录制失败，具体请参考错误描述。
InvalidParameter.BodyParameterTypeUnmatched 参数类型不匹配。
InvalidParameter.TaskNotFound 需要查询的任务不存在。
ResourceUnavailable.NotRegistered 未开通互动白板。
ResourceUnavailable.ServiceExpired 账户欠费或者互动白板服务已过期。
UnauthorizedOperation.SdkAppId SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。
中国站