你可以使用此接口查询指定录制任务的相关信息。

接口行为

如果有多个任务, 会返回最新创建的录制任务。

录制文件生成后,不推荐调用 GetRecordTask接口获取录制生成的文件,强烈建议接入录制结束回调事件。

通过此接口仅能查询距今 72 小时内开始的录制任务。

前置条件

在查询前,你必须已经在控制台上开启录制功能,参看在控制台开启/关闭云端录制功能。

调用接口

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

接口限制

QPS 不得超过 60。

请求方式

使用 Get 方式发起请求。

请求参数

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

Query
参数名类型必填示例值描述
ActionString是GetRecordTask接口名称,本接口取值:GetRecordTask
VersionString是2022-06-01接口版本,本接口取值:2022-06-01
AppIdString是Your_AppId你的音视频应用的唯一标志
RoomIdString是Your_RoomId房间的 ID,是房间的唯一标志
TaskIdString是Your_TaskId要查询的云端录制任务 ID。
请求示例代码
Query
https://rtc.volcengineapi.com?Action=GetRecordTask&Version=2022-06-01&AppId=Your_AppId&RoomId=Your_RoomId&TaskId=Your_TaskId
返回调用结果

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

参数名类型描述
RecordTaskRecordTask录制任务信息
正常返回示例
{
    "Result": {
        "RecordTask": {
            "StartTime": 1624873773000,
            "EndTime": 1624874235000,
            "Status": 3,
            "StopReason": "StopByAPI",
            "RecordFileList": [
                {
                    "Vid": "Your_Vid",
                    "Duration": 457280,
                    "Size": 30388433,
                    "StartTime": 1624873773354,
                    "StreamList": [
                        {
                            "UserId": "Your_UserId",
                            "StreamType": 0
                        }
                    ]
                }
            ]
        }
    },
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "GetRecordTask",
        "Version": "2022-06-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}
json