你可以使用此接口查询指定页面转推任务的相关信息。

接口行为

你可以调用GetWebCastTask接口，指定你所属的 AppId，查询指定 RoomId 下的页面转推任务。

通过此接口仅能查询距今 72 小时内开始的页面转推任务。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

接口限制

QPS 不得超过 60。

请求方式

使用 Get 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数，参看请求参数。

Query

参数名	类型	必填	示例值	描述
Action	String	是	`GetWebCastTask`	接口名称，本接口取值：`GetWebCastTask`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`2020-12-01`
AppId	String	是	`Your_AppId`	你的音视频应用的唯一标志
RoomId	String	是	`Your_RoomId`	房间的 ID，是房间的唯一标志
TaskId	String	否	`Your_TaskId`	要查询的页面转推任务 ID。

请求示例代码

Query

https://rtc.volcengineapi.com?Action=GetWebCastTask&Version=2020-12-01&AppId=Your_AppId&RoomId=Your_RoomId&TaskId=Your_TaskId

返回调用结果

返回结果参看 BaseResponse。
其中 Result 的结构如下：

参数名	类型	描述
WebCastTask	WebCastTask	页面转推任务信息

WebCastTask

参数名	类型	描述
StartTime	Uint64	任务开始时间戳，Unix 时间，单位为毫秒
EndTime	Uint64	任务结束时间戳，Unix 时间，单位为毫秒。`0` 表示任务未结束
Status	Uint64	任务状态。 `0`: 未知异常状态 `1`: 未开始 `2`: 运行中 `3`: 已结束 `4`: 任务运行失败
StopReason	String	任务停止的原因 `无`：表示任务未结束 `UnknownStopReason`：未知停止原因 `StopByAPI`：用户主动调用服务端 OpenAPI 停止 `StartTaskFailed`：任务启动失败 `ExceedMaxRunningTime`：任务超过最大运行时间
UserId	String	推送网页音视频内容的用户对应的 UserId
SourceURL	String	需要转推的网页地址，可以携带自定义的 queryParams 来鉴权等，总体长度不超过 1024。
VideoSolutions	[]VideoSolution	输出的视频参数，最多支持2路，以大小流的方式支持接收端按需订阅，将以最大的视频流分辨率作为网页渲染分辨率，为空时按默认值填充一路
MaxRunningTime	Int	最大运行时间，超过此时间后，任务自动终止。单位为秒。取值范围为 [10,86400]，默认值为 `86400`。不填时自动调整为默认值。
Monitor	MonitorConfig	页面可用性监控配置
EventNotify	EventNotifyConfig	页面事件通知配置。若需要避免未载入完成时的不完整页面被采集，可以启用此配置。

正常返回示例

{
    "Result": {
        "WebcastTask": {
            "StartTime": 1676987478000,
            "EndTime": 1676987489000,
            "Status": 3,
            "StopReason": "StopByAPI",
            "UserId": "Your_UserId",
            "SourceURL": "https://xxxxx",
            "VideoSolutions": [
                {
                    "Width": 1920,
                    "Height": 1080,
                    "FrameRate": 60,
                    "Bitrate": 10000
                }
            ],
            "MonitorConfig": {
                "BlankCheckInterval": 5,
                "CrashCheckInterval": 5,
                "FreezeCheckInterval": 5
            },
            "EventNotifyConfig": {
                "EnableEventNotify": true,
                "StartTimeout": 2
            },
            "MaxRunningTime": 3600
        }
    },
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "GetWebCastTask",
        "Version": "2020-12-01"
    }
}
json