Help Center/ Meeting/ Server API Reference/ Meeting Management/ APIs/ Querying the Recording File List
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Recording File List

Description

This API is used to query the meeting recording list. The administrator can query all recordings in the enterprise. Common users can query only the recordings of meetings created by themselves. If no query parameter is carried, recording files within the permissions scope are queried by default.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

GET

Request Address

/v1/mmc/management/record/files

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

userUUID

No

String

Query

UUID of a user.

NOTE:

Only administrators have the permission to query the recording list of other users in the enterprise. For a common user, this parameter is invalid. Common users can query only recordings of themselves.

offset

No

Integer

Query

Query offset. Default value: 0.

limit

No

Integer

Query

Number of records to query. The default value is 20 and the maximum value is 500.

queryAll

No

Boolean

Query

Whether to query meeting recordings of all users in the enterprise.

  • true: Query meeting recordings of all users.
  • false: Query only meeting recordings of the administrator.
    NOTE:

    This parameter is valid only for enterprise administrators.

searchKey

No

String

Query

Query condition. The meeting topic, user who schedules the meeting, and meeting ID can be used as the keywords.

startDate

Yes

long

Query

Query start timestamp, in milliseconds.

endDate

Yes

long

Query

Query end timestamp, in milliseconds.

sortType

No

String

Query

Sorting style of the query results.

  • ASC_StartTIME: Records are sorted by start time in ascending order.
  • DSC_StartTIME: Records are sorted by start time in descending order.

X-Access-Token

Yes

String

Header

Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID.

X-Authorization-Type

No

String

Header

Whether the request is sent from a third-party portal.

NOTE:

This parameter will be discarded. Do not use it.

X-Site-Id

No

String

Header

ID of the HCS Online site where the authentication is performed.

NOTE:

This parameter will be discarded. Do not use it.

Status Codes

Table 3 Status codes

HTTP Status Code

Description

200

Operation successful.

400

Invalid parameters.

401

Authentication is not performed or fails.

403

Insufficient permissions.

500

Server exception.

Response Parameters

Table 4 Response parameters

Parameter

Type

Description

offset

Integer

Query offset.

limit

Integer

Number of records on each page.

count

Integer

Total number of records.

data

Array of RecordFileInfo objects

Recording file list.
Table 5 RecordFileInfo data structure

Parameter

Type

Description

confUUID

String

Meeting UUID.

confID

String

Meeting ID.

url

String[]

Recording playback URL.

rcdTime

Integer

Recording duration, in seconds.

rcdSize

Integer

Recording file size, in MB.

subject

String

Meeting topic.

scheduserName

String

Name of the meeting scheduler.

startTime

String

Meeting start time.

isDecodeFinish

Boolean

Whether the recording file is transcoded.

decodeEndTime

long

Estimated time when transcoding of a recording file will complete.

available

Boolean

Whether the recording file can be played.

recordAuthType

Integer

Recording playback authentication mode. This parameter is valid only when recordType is set to 2 or 3.

  • 0: Users who obtain the link of the recording can watch or download the recording.
  • 1: Only enterprise users can watch or download the recording.
  • 2: Only meeting participants can view and download the recording.

Example Request

GET /v1/mmc/management/record/files?startDate=1574092800000&endDate=1576771199999
Connection: keep-alive
X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 683
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 25b89efb63970d80e715503650157098
Server: api-gateway
X-Request-Id: a9af536f02e45c516513a8248bfe04c3

{
    "offset": 0,
    "limit": 20,
    "count": 1,
    "data": [
        {
            "confUUID": "51adf610220411eaaae03f22d33cc26b",
            "confID": "912049654",
            "url": [
                "https://114.116.237.2/rse/rse/html/play/Mediaxplay.html?rseid=00030&recordId=000301fa-0512-412f-b363-cb9f76063628&token=24e4f6d9850a42365783c88ceb36701bb87f5393a595af82&confID=51adf610220411eaaae03f22d33cc26b&isSecure=true"
            ],
            "rcdTime": 71,
            "rcdSize": 0,
            "subject": "user8002's meeting",
            "scheduserName": "user8002",
            "startTime": "2019-12-19 02:07",
            "isDecodeFinish": false,
            "decodeEndTime": 1576721412885,
            "available": true,
            "recordAuthType":2
        }
    ]
}

Error Codes

If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.

Example cURL Command

curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' 'https://api.meeting.huaweicloud.com/v1/mmc/management/record/files?startDate=1574092800000&endDate=1576771199999'
Parent topic: APIs