文档中心

实时音视频

云录屏

查询云录屏任务状态 GetWebCastTask

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

调用 GetWebCastTask 接口，查询指定云录屏任务的详细信息，包括任务状态、起止时间、源网页地址及视频参数等。可查询最近 72 小时内的云录屏任务。

注意事项

请求频率：QPS 不得超过 60。

请求说明

请求方式：GET

请求地址：https://rtc.volcengineapi.com?Action=GetWebCastTask&Version=2023-11-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

Action String 必选示例值：GetWebCastTask

接口名称。当前 API 的名称为 GetWebCastTask。

Version String 必选示例值：2023-11-01

接口版本。当前 API 的版本为 2023-11-01。

AppId String 必选示例值：66****3cf

实时音视频应用的 AppId。可在控制台获取。

RoomId String 必选示例值：Room1

房间 ID。

TaskId String 必选示例值：Task1

要查询的云录屏任务 ID。

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

WebCastTask Object 示例值：-

云录屏任务信息。

StartTime Long 示例值：1676987478000

任务开始时间戳，Unix 时间，单位为毫秒。

EndTime Long 示例值：1676987489000

任务结束时间戳，Unix 时间，单位为毫秒。0 表示任务未结束

Status Long 示例值：3

任务状态。支持取值及含义如下：

0：未知异常状态

1：未开始

2：运行中

3：已结束

4：任务运行失败

StopReason String 示例值：StopByAPI

任务停止的原因：

返回为空：表示任务未结束

UnknownStopReason：未知停止原因

StopByAPI：用户主动调用服务端 OpenAPI 停止

StartTaskFailed：任务启动失败

ExceedMaxRunningTime：任务超过最大运行时间

UserId String 示例值：User1

推送网页音视频内容的用户对应的 UserId。

SourceURL String 示例值：https://xxxxx

转推的网页地址。

VideoSolutions Object[] 示例值：-

输出的视频参数。

Width Integer 示例值：1280

视频宽度，单位为像素。

Height Integer 示例值：720

视频高度，单位为像素。

FrameRate Integer 示例值：15

发送帧率，单位为 fps。

Bitrate Integer 示例值：0

最大发送码率，单位为 Kbps。

MaxRunningTime Integer 示例值：86400

最大运行时间，超过此时间后，任务自动终止。单位为秒。

MonitorConfig Object 示例值：-

页面可用性监控配置。

FreezeCheckInterval Integer 示例值：5

对页面内容是否无变化的检测间隔，单位为秒。默认值为 0，表示不启用。

当连续两次出现检测命中时，将对页面进行刷新，并回调Status=4，Reason="PageFreeze"。

再次出现连续两次检测命中时，将进行任务重调度，并回调Status=5，Reason="PageFreeze"。

注意：页面无变化可能是您业务的正常场景，请谨慎评估页面实际内容情况后再开启此功能，以免任务提前退出。

BlankCheckInterval Integer 示例值：5

对页面是否白屏的检测间隔，单位为秒。默认值为0，表示不启用。

当连续两次出现检测命中时，将对页面进行刷新，并回调Status=4，Reason="PageBlank" 。

再次出现连续两次检测命中时将进行任务重调度，并回调Status=5，Reason="PageBlank"。

注意：页面全白可能是您业务的正常场景，请谨慎评估页面实际内容情况后再开启此功能，以免任务提前退出。

CrashCheckInterval Integer 示例值：5

对页面 JS 线程是否崩溃/卡死的检测间隔，单位为秒。默认值为 0，表示不启用。

当出现检测命中时将进行任务重调度，并回调 Status=5，Reason="PageCrash"。

EventNotifyConfig Object 示例值：-

页面事件通知配置。若需要避免未载入完成时的不完整页面被采集，可以启用此配置。

EnableEventNotify Boolean 示例值：true

是否启用页面主动事件通知。

false：页面在打开后就会开始采集，在收到 StopWebCast openAPI 请求后结束采集。

true：在页面中注入两个 JS 函数：onWebcastStart()和 onWebcastEnd()。

当页面判断资源加载完成之后调用onWebcastStart()，控制程序才会开始进行页面内容的采集。当页面判断本次任务内容已完成时调用onWebcastEnd() 通知控制程序结束本次任务。StopWebCast openAPI 效果不变，业务可提前结束任务。其他页面内容、JS 线程的检测（若启用），将在收到 onWebcastStart()事件后才开始。

当启用页面主动事件通知后，你可以参考以下示例代码来通知采集开始。

StartTimeout Integer 示例值：2

启用页面主动事件通知后，等待开始事件的超时时间，单位为秒。默认值为 0，表示不启用。仅当 EnableEventNotify 为 true 时，此参数有效。

当在超时时间内收到开始事件，采集功能正常运行，用户将收到 Status=1的回调。

当超时时间内未收到开始事件，将进行刷新，等待时间被重置，再次发生超时后将进行任务重调度。刷新时将回调 Status=4，Reason=" StartEventTimeout"。重调度时将回调 Status=5，Reason="StartEventTimeout"。

请求示例

返回示例

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2026.07.18 23:50:57

这个页面对您有帮助吗？

有用

无用