Documentation
Cloud Recording
API Documents
Query Record Task List

Query the recording task list

Last updated：2024-10-17 15:02

Description

Queries the list of ongoing and completed recording tasks.

Request method and endpoint

Request method: POST
Request endpoint: https://cloudrecord-api.zego.im/?Action=DescribeTasks
Transmission protocol: HTTPS
Rate limit: 10 requests/second

Request parameters

Listed below are the parameters specific to this request. For the list of public request parameters, see Accessing Server APIs - Public parameters.

Parameter	Type	Required	Description
Status	Int	Yes	2: ongoing recording task 3: completed recording task
RoomId	String	No	ID of the room whose recording task needs to be queried. If this parameter is not set, recording tasks of all rooms under the AppId will be queried.
PageOffset	Int	No	Page number when the pagination query mode is used. The value starts from 1. If this parameter is not set or set to 0, the value `1` is used by default.
PageSize	Int	No	Number of records on each page when the pagination query mode is used. The value must be greater than 0 and less than or equal to 50. If this parameter is not set, the value `50` is used by default.
StartTime	Int64	Yes	Query start time, in ms. The value is a Unix timestamp and can't be earlier than 3 days before the current time.
EndTime	Int64	Yes	Query end time, in ms. The value is a Unix timestamp and must be later than the time specified by `StartTime`. The query time range can't exceed 3 days and the method will return only the records found within this time range.

Sample request

The following is a request example of the DescribeTasks method:

Request URL

https://cloudrecord-api.zego.im/?Action=DescribeTasks
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0

Request message body

{
  "Status":2,
  "RoomId":"1230",
  "StartTime": 1628474401000,
  "EndTime": 1628475402000,
  "PageOffset": 1,
  "PageSize": 50
}

Response parameters

Parameter	Type	Description
Code	Int64	Return code.
Message	String	Description of the request execution result.
RequestId	String	Request ID.
Data	Object	Response object. For details, see Data member parameters.

Listed below are Data member parameters.

Parameter	Type	Description
PageOffset	Int	Page number when the pagination query mode is used.
PageSize	Int	Number of records on each page when the pagination query mode is used.
TotalCount	Int	Total number of query results.
TaskList	JSON Array	For details, see TaskList member parameters.

Listed below are TaskList member parameters.

Parameter	Type	Description
RecordBeginTimestamp	Int64	Recording start timestamp.
TaskId	String	Recording task ID.
RoomId	String	Room ID.
Status	Int	Recording status. 1: initialized 2: ongoing 3: completed 4: ended abnormally 5: paused

Sample response

The following is a response example of the DescribeTasks method:

{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "abcd123",
    "Data": {
        "PageOffset": 1,
        "PageSize": 50,
        "TotalCount": 3,
        "TaskidList": [
            {
                "RecordBeginTimestamp": 1628565227899,
                "TaskId": "YRHu6-E4IyvEAAAD",
                "RoomId": "1000",
                "Status": 2
            },
            {
                "RecordBeginTimestamp": 1628565226303,
                "TaskId": "YRHu6uE4IyvEAAAC",
                "RoomId": "1000",
                "Status": 2
            },
            {
                "RecordBeginTimestamp": 1628565222498,
                "TaskId": "YRHu5uE4IyvEAAAB",
                "RoomId": "1000",
                "Status": 2
            }
        ]
    }
}