DescribeRecordStatus

POST

https://cloudrecord-api.zego.im/

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

说明

调用频率限制：10 次/秒

Request

Query Parameters

Action string必填

可选值: [DescribeRecordStatus]

接口原型参数

https://cloudrecord-api.zego.im?Action=DescribeRecordStatus

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

TaskId string必填

录制任务 ID，长度固定为 16 个字节的字符串。

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code int64

错误码。

Message string

错误描述。

RequestId string

请求 ID。

Data object

响应对象。

RoomId string

录制的目标房间。

RecordMode integer

录制模式。请参考开始录制接口。

StreamType integer

录制媒体流类型。请参考开始录制接口。

RecordBeginTimestamp int64

录制任务开始的时间，为 Unix 时间戳，单位：ms。

RecordEndTimestamp int64

录制任务结束的时间，为 Unix 时间戳，单位：ms。

Status integer

可选值: [1, 2, 3, 4, 5]

录制任务的状态。

1：录制任务初始化
2：录制任务进行中
3：录制任务已结束
4：录制任务异常结束
5：录制任务暂停中

RecordFiles object[]

文件信息。如果使用了视频截图功能，则不返回该字段。

注意

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

Array[

UserId string

录制流对应的推流用户 ID（混流时，为 MixOutputStreamId）。

UserName string

录制流对应的推流用户昵称（混流时，为 MixOutputStreamId）。

StreamId string

录制流对应的流 ID（混流时，为 MixOutputStreamId）。

FileId string

文件 ID，请参考开始录制接口中的 OutputFileRule 参数。

VideoId string

阿里云 Vod、腾讯云 Vod 上传成功得到的视频 ID 参数。阿里云 Vod 对应的是 VideoId，腾讯云 Vod 对应的是 FileId。

FileUrl string

文件访问 URL。第三方存储为七牛云或阿里云 Vod 时不返回。

OutputFileFormat string

可选值: [mp4, flv, hls, jpg, aac]

输出录制文件的格式，包括 "mp4"、"flv"、"hls"、"jpg" 和 "aac"。

FileSize int64

文件大小，单位：字节。

Duration integer

文件时长，单位：ms。

ResolutionWidth integer

视频分辨率宽，单位：像素。

ResolutionHeight integer

视频分辨率高，单位：像素。

MediaTrackType integer

可选值: [1, 2, 3]

文件媒体类型。

1：只有音频
2：只有视频
3：音视频

BeginTimestamp int64

开始录制文件时的 Unix 时间戳，单位：ms。