logo
ConsoleSign Up
Document
Server API
Cloud Recording
Overview
Accessing server APIs
Call API Online
POST
Start recording
POST
Stop recording
POST
Update the mixed stream layout
POST
Update the whiteboard layout
POST
Query recording status
POST
Query the record task list
POST
Pause recording
POST
Resume recording
POST
Take a Snapshot
Recording status callback
Return codes
On this page

DescribeTasks

POST

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

After starting recording, developers can call this API to query the list of recording tasks that are in progress or have ended.

Note
Call frequency limit: 10 times/second

Request

Query Parameters

    Action stringrequired

    Possible values: [DescribeTasks]

    API prototype parameter

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

    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.

Body

required
    Status integerrequired

    Possible values: [2, 3]

    Recording task status.

    • 2: Indicates tasks that are currently recording.
    • 3: Indicates tasks that have ended recording.
    RoomId string

    Used to specify the room number for querying recording tasks. When not filled in, queries recording tasks for all rooms under the AppId.

    PageOffset integer

    Possible values: >= 1

    Default value: 1

    Page number for paginated queries, starting from 1. When not filled in or filled in as 0, defaults to 1.

    PageSize integer

    Possible values: >= 1 and <= 50

    Default value: 50

    Number of records per page for paginated queries. This value must be less than or equal to 50 and greater than 0. When not filled in, defaults to 50.

    StartTime int64required

    Query start time, Unix timestamp in milliseconds. Start time cannot be earlier than 3 days before the current time.

    EndTime int64required

    Query end time, Unix timestamp in milliseconds. EndTime must be greater than StartTime, and the query time span cannot exceed 3 days. The API only returns records where the recording start time is within the query time range.

Responses​

OK
Schema
    Code int64

    Error code.

    Message string

    Error description.

    RequestId string

    Request ID.

    Data object
    Response object.
    PageOffset integer

    Page number for paginated queries.

    PageSize integer

    Number of records per page for paginated queries.

    TotalCount integer

    Total number of query results.

    TaskidList object[]
    Recording task list.
  • Array[
    • RecordBeginTimestamp int64

    Recording start timestamp in milliseconds.

    TaskId string

    Recording task ID.

    RoomId string

    Target room ID for recording.

    Status integer

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

    Recording status.

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

Previous

Query recording status

Next

Pause recording

On this page

Back to top