DescribeRecordStatus

POST

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

After starting recording, developers can call this API to query the status of recording tasks. Supports querying tasks whose recording start time is within three days of the API call.

Note

Call frequency limit: 10 times/second

Request

Query Parameters

Action stringrequired

Possible values: [DescribeRecordStatus]

API prototype parameter

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

AppId uint32required

💡Common parameter. Application ID, a unique credential assigned by ZEGOCLOUD. You can obtain it from the ZEGOCLOUD Console.

SignatureNonce stringrequired

💡Common parameter. A 16-character hexadecimal random string (hex encoding of an 8-byte random number). For the generation algorithm, refer to Signature Example.

Timestamp int64required

💡Common parameter. Current Unix timestamp in seconds. For the generation algorithm, refer to Signature Example. A maximum error of 10 minutes is allowed.

SignatureVersion stringrequired

Possible values: [2.0]

Default value: 2.0

💡Common parameter. Signature version number.

Signature stringrequired

💡Common parameter. Signature used to verify the legitimacy of the request. Please refer to Signature Mechanism for generation.

application/json

Body

required

TaskId stringrequired

Recording task ID, a fixed-length string of 16 bytes.

Responses

application/json

Schema
Example (from schema)

Schema

Code int64

Error code.

Message string

Error description.

RequestId string

Request ID.

Data object

Response object.

RoomId string

Target room for recording.

RecordMode integer

Recording mode. Please refer to the Start recording API.

StreamType integer

Recording media stream type. Please refer to the Start recording API.

RecordBeginTimestamp int64

Recording task start time, Unix timestamp in milliseconds.

RecordEndTimestamp int64

Recording task end time, Unix timestamp in milliseconds.

Status integer

Possible values: [1, 2, 3, 4, 5]

Recording task status.

1: Recording task initialization
2: Recording task in progress
3: Recording task ended
4: Recording task ended abnormally
5: Recording task paused

RecordFiles object[]

File information.This field is not returned if the video screenshot feature is used.

Warning

When the recording task is in ended status, if no users published streams in the room during the recording process, no recording files will be generated and the RecordFiles field will not be returned.

Array[

UserId string

User ID of the stream being recorded (for stream mixing, this is MixOutputStreamId).

UserName string

User nickname of the stream being recorded (for stream mixing, this is MixOutputStreamId).

StreamId string

Stream ID of the stream being recorded (for stream mixing, this is MixOutputStreamId).

FileId string

File ID. Please refer to the OutputFileRule parameter in the Start recording API.

VideoId string

Video ID parameter obtained after successful upload to Alibaba Cloud VOD or Tencent Cloud VOD. For Alibaba Cloud VOD, this corresponds to VideoId; for Tencent Cloud VOD, this corresponds to FileId.

FileUrl string

File access URL. Not returned when third-party storage is Qiniu Cloud or Alibaba Cloud VOD.

OutputFileFormat string

Possible values: [mp4, flv, hls, jpg, aac]

Output recording file format, including "mp4", "flv", "hls", "jpg", and "aac".

FileSize int64

File size in bytes.

Duration integer

File duration in milliseconds.

ResolutionWidth integer

Video resolution width in pixels.

ResolutionHeight integer

Video resolution height in pixels.

MediaTrackType integer

Possible values: [1, 2, 3]

File media type.

1: Audio only
2: Video only
3: Audio and video

BeginTimestamp int64

Unix timestamp when file recording started, in milliseconds.