你可以使用此接口查询指定录制任务的相关信息。
如果有多个任务, 会返回最新创建的录制任务。
录制文件生成后,不推荐调用 GetRecordTask接口获取录制生成的文件,强烈建议接入录制结束回调事件。
通过此接口仅能查询距今 72 小时内开始的录制任务。
在查询前,你必须已经在控制台上开启录制功能,参看在控制台开启/关闭云端录制功能。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。
使用 Get 方式发起请求。
以下是接口特有的请求参数。关于其他公共请求参数,参看请求参数。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetRecordTask | |
| Version | String | 是 | 2020-12-01 | OpenAPI 版本 |
| AppId | String | 是 | Your_AppId | 你的音视频应用的唯一标志 |
| RoomId | String | 是 | Your_RoomId | 房间的 ID,是房间的唯一标志 |
| TaskId | String | 是 | Your_TaskId | 要查询的云端录制任务 ID。 |
https://rtc.volcengineapi.com?Action=GetRecordTask&Version=2020-12-01&AppId=5a7451222679214f668e7085&RoomId=rtcqa77805&TaskId=luzhi-001
请求返回值参看 BaseResponse。
其中,Result 的结构如下。
| 参数名 | 类型 | 描述 |
|---|---|---|
| RecordTask | RecordTask | 录制任务信息 |
| 参数名 | 类型 | 描述 |
|---|---|---|
| StartTime | uint64 | 任务开始的时间,为 Unix 时间戳,单位毫秒 |
| EndTime | uint64 | 任务结束的时间,为 Unix 时间戳,单位毫秒。0 表示任务未结束 |
| Status | uint64 | 任务状态: |
| StopReason | string | 任务停止的原因: |
| RecordFileList | array of RecordFile | 录制生成的文件列表。 |
{
"Result": {
"RecordTask": {
"StartTime": 1624873773000,
"EndTime": 1624874235000,
"Status": 3,
"StopReason": "StopByAPI",
"RecordFileList": [
{
"Vid": "v02e96g10000c3cppu139mhmps58of80",
"Duration": 457280,
"Size": 30388433,
"StartTime": 1624873773354,
"StreamList": [
{
"UserId": "pl122",
"StreamType": 0
}
]
}
]
}
},
"ResponseMetadata": {
"RequestId": "278e2d57-3cd5-49d5-9f0c-06b346e8c9c7",
"Action": "GetRecordTask",
"Version": "2020-12-01"
}
}
json