云端录制旧版文档
  • 快速开始
  • 常用功能
  • API 文档
  • 常见错误码
  • 文档中心
  • 云端录制旧版文档
  • API 文档
  • 查询录制状态

查询录制状态

更新时间:2021-09-26 17:15

1 描述

开始录制后,开发者可以通过调用本接口来查询录制任务的状态。支持查询录制开始时间在发起接口调用时三天内的任务。

2 接口原型

  • 请求方式:POST/JSON

  • 请求地址:

    服务环境 调用频率限制 请求地址
    国内正式环境
    10 次/秒
    https://cloudrecord-sh.zego.im/query
    国内测试环境
    10 次/秒
    https://cloudrecord-test.zego.im/query
    海外正式环境
    10 次/秒
    https://cloudrecord-hk.zegocloud.com/query
    海外测试环境
    10 次/秒
    https://cloudrecord-test.zegocloud.com/query
  • 传输协议:HTTPS

3 请求参数

参数 类型 是否必选 描述
app_id
Int64
ZEGO 给开发者分配的 AppID,唯一标识一个应用。
access_token
String
接口鉴权凭证,通过 获取 AccessToken 接口获取。
task_id
Int
录制任务 ID,长度固定为 16 个字节的字符串。

4 请求示例

以下是 query 接口的请求示例。

{
    "app_id": 0000,
    "access_token": "xxxx",
    "task_id": "X3CgNeE4I1qAAABN"
}

5 响应参数

参数 类型 描述
code
Int
错误码。
message
String
错误描述。
room_id
String
要录制的目标房间。
record_mode
Int
请参考 开始录制
stream_type
Int
请参考 开始录制
record_begin_timestamp
Int64
录制开始的时间,为 Unix 时间戳,单位:ms。
record_end_timestamp
Int64
录制结束的时间,为 Unix 时间戳,单位:ms。
status
Int
录制状态。
  • 1:录制任务初始化
  • 2:录制任务进行中
  • 3:录制任务已结束
  • 4:录制任务异常结束
  • 5:录制任务暂停中
record_files
Array of Object
文件信息。
详见 record_files 成员列表
如果使用了视频截图功能,则不返回该字段。

录制任务为已结束状态时,如果录制过程中房间内无用户推流,则不会产生录制文件,也不会返回 record_files 字段。

record_files 成员如下:

参数 类型 描述
user_id String 录制流对应的推流用户 ID(混流时,为 mix_output_stream_id)。
user_name String 录制流对应的推流用户昵称(混流时,为 mix_output_stream_id)。
stream_id String 录制流对应的流 ID(混流时,为 mix_output_stream_id)。
file_id String 请参考 开始录制 中的 output_file_rule 参数。
video_id String 阿里云 Vod、腾讯云 Vod 上传成功得到的视频 ID 参数。阿里云 Vod 对应的是 VideoId,腾讯云 Vod 对应的是 FileId。
file_url String 文件访问 URL。第三方存储为七牛云或阿里云 Vod 时不返回。
output_file_format String 输出录制文件的格式,包括“mp4”、“flv”、“hls”、“jpg” 和 “aac”。
file_size Int64 文件大小,单位:字节。
duration Int 文件时长,单位:ms。
resolution_width Int 视频分辨率宽,单位:像素。
resolution_height Int 视频分辨率高,单位:像素。
media_track_type Int 文件媒体类型。
  • 1:只有音频
  • 2:只有视频
  • 3:音视频
begin_timestamp Int64 接收到房间流新增信令时的 Unix 时间戳,单位:ms。
custom_begin_timestamp Int64 用户自定义时间戳,该时间戳带在流 SEI 信息中,按照约定的协议从 SEI 中解析。
status Int 文件状态。
  • 1:录制中,表示正在录制文件。
  • 2:上传中,表示正在上传录制文件至客户指定云存储。
  • 3:上传成功,表示上传录制文件至客户指定云存储成功。
  • 4:已经上传至备份云存储,表示上传客户指定云存储失败,已上传至 ZEGO 备份云存储。
  • 5:上传失败,表示上传客户指定云存储和 ZEGO 备份云存储均失败。

6 响应示例

以下是 query 接口的响应示例。

{
    "code": 0,
    "message": "succeed",
    "room_id": "xxxx",
    "record_mode": 2,
    "stream_type": 3,
    "record_begin_timestamp": 1601221452099,
    "record_end_timestamp": 1601221508795,
    "status": 3,
    "record_files": [
        {
            "user_id": "my_out",
            "user_name": "my_out",
            "stream_id": "my_out",
            "file_id": "X3CgNeE4I1qAAABN_xxxx_my_out_VA_20200927154419775.mp4",
            "video_id": "820e50e52e0a490caf44eec8aec527a7",
            "output_file_format": "mp4",
            "file_size": 432643544,
            "duration": 33874,
            "resolution_width": 1920,
            "resolution_height": 1080,
            "media_track_type": 3,
            "begin_timestamp": 1601221459830,
            "custom_begin_timestamp": 0,
            "status": 3,
            "file_url": "https://xxxx.oss-cn-shanghai.aliyuncs.com/record/X3CgNeE4I1qAAABN_xxxx_my_out_VA_20200927154419775.mp4"
        }
    ]
}
本篇目录