Help Center/ Meeting/ Server API Reference/ Meeting Management/ APIs/ Querying the Historical Meeting List
Updated on 2024-01-19 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Historical Meeting List

Description

This API is used to query meetings that have ended. Administrators can query all historical meetings in the enterprise. Common users can query only historical meetings created by themselves or those they are invited to. If no query parameter is not specified, historical meetings within the permissions scope are queried by default.

  • If a common user used the meeting ID or link to join the meeting, but the user was not invited by the scheduler before the meeting starts or by the host during the meeting, the user cannot be queried in the participant list of the historical meeting.
  • If a meeting was held and ended for multiple times, multiple historical meetings (with the same meeting ID but different meeting UUIDs) were generated.
  • Historical meeting records are retained for six months by default and for up to 12 months. Administrators can change the retention period on the Meeting Settings page.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

GET

Request Address

/v1/mmc/management/conferences/history

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

userUUID

No

string

Query

UUID of a user.

NOTE:

This parameter will be discarded. Do not use it.

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.

searchKey

No

string

Query

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

queryAll

No

Boolean

Query

Whether to query historical meetings of all users in the enterprise.

  • true: Query historical meetings of all users.
  • false: Query only historical meetings of the administrator.
    NOTE:

    This parameter is valid only for enterprise administrators.

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.
  • ASC_RecordTYPE: Records are sorted by start time in ascending order and meetings with recording files are displayed on the top of the list.
  • DSC_RecordTYPE: Records are sorted by start time in descending order and meetings with recording files are displayed on the top of the list.

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 ConferenceInfo objects

Meeting list.

Example Request

GET /v1/mmc/management/conferences/history?startDate=1574092800000&endDate=1574179199999
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: 2420
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 43bee1151af8115d90358994a7c14cfc
Server: api-gateway
X-Request-Id: 53c883710d86aebf01e92ce7bcea1984

{
    "data": [
        {
            "conferenceID": "914083388",
            "mediaTypes": "Voice,Video,Data",
            "subject": "user8001's test meeting",
            "size": 1,
            "timeZoneID": "56",
            "startTime": "2019-11-18 23:31",
            "endTime": "2019-11-18 23:32",
            "conferenceState": "Destroyed",
            "accessNumber": "+991117",
            "language": "zh-CN",
            "passwordEntry": [
                {
                    "conferenceRole": "general",
                    "password": "******"
                }
            ],
            "userUUID": "ff8080816a024f05016a4e2342480a60",
            "scheduserName": "test008",
            "multiStreamFlag": 1,
            "conferenceType": 0,
            "confType": "IMMEDIATELY",
            "isAutoMute": 1,
            "isAutoRecord": 0,
            "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083388/1f215673e636444b55845ee1d1af630e8d8ca0235e491972",
            "recordType": 0,
            "recordAuxStream": 0,
            "recordAuthType": 0,
            "confConfigInfo": {
                "prolongLength": 15,
                "isGuestFreePwd": false,
                "isSendNotify": true,
                "isSendSms": true,
                "isAutoMute": true,
                "isSendCalendar": true,
                "callInRestriction": 0,
                "allowGuestStartConf": true,
                "isHardTerminalAutoMute": true,
                "enableWaitingRoom": true
            },
            "vmrFlag": 0,
            "scheduleVmr": false,
            "isHasRecordFile": false,
            "partAttendeeInfo": [
                {
                    "phone": "+99111****380",
                    "name": "user8002",
                    "type": "normal"
                }
            ],
            "terminlCount": 0,
            "normalCount": 1,
            "deptName": "wangyue",
            "confUUID": "9a0fa6d10a5b11eaae5e191763c22c0e"
        },
        {
            "conferenceID": "914088193",
            "mediaTypes": "Voice,Video,Data",
            "subject": "user8001's meeting",
            "size": 1,
            "timeZoneID": "56",
            "startTime": "2019-11-18 23:31",
            "endTime": "2019-11-18 23:31",
            "conferenceState": "Destroyed",
            "accessNumber": "+991117",
            "language": "zh-CN",
            "passwordEntry": [
                {
                    "conferenceRole": "general",
                    "password": "******"
                }
            ],
            "userUUID": "ff8080816a024f05016a4e2342480a60",
            "scheduserName": "test008",
            "multiStreamFlag": 1,
            "conferenceType": 0,
            "confType": "IMMEDIATELY",
            "isAutoMute": 1,
            "isAutoRecord": 0,
            "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914088193/5b00be0e5121eb2f6f865162a4bc7f1f7f05d37cd802dded",
            "recordType": 2,
            "recordAuxStream": 0,
            "recordAuthType": 0,
            "confConfigInfo": {
                "prolongLength": 15,
                "isGuestFreePwd": false,
                "isSendNotify": true,
                "isSendSms": true,
                "isAutoMute": true,
                "isSendCalendar": true,
                "callInRestriction": 0,
                "allowGuestStartConf": true,
                "isHardTerminalAutoMute": true,
                "enableWaitingRoom": true
            },
            "vmrFlag": 0,
            "scheduleVmr": false,
            "isHasRecordFile": false,
            "partAttendeeInfo": [
                {
                    "phone": "+991116004380",
                    "name": "user8002",
                    "type": "normal"
                }
            ],
            "terminlCount": 0,
            "normalCount": 1,
            "deptName": "wangyue",
            "confUUID": "7c421ac60a5b11eaa5e83b30677ab12b"
        },
        {
            "conferenceID": "914085971",
            "mediaTypes": "Voice,Video,Data",
            "subject": "user8001's meeting",
            "size": 1,
            "timeZoneID": "56",
            "startTime": "2019-11-18 23:30",
            "endTime": "2019-11-18 23:31",
            "conferenceState": "Destroyed",
            "accessNumber": "+991117",
            "language": "zh-CN",
            "passwordEntry": [
                {
                    "conferenceRole": "general",
                    "password": "******"
                }
            ],
            "userUUID": "ff8080816a024f05016a4e2342480a60",
            "scheduserName": "test008",
            "multiStreamFlag": 1,
            "conferenceType": 0,
            "confType": "IMMEDIATELY",
            "isAutoMute": 1,
            "isAutoRecord": 0,
            "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914085971/40300b325ad71ad1ff2c1dbdda1250328ccd8ec9ff45bd03",
            "recordType": 2,
            "recordAuxStream": 0,
            "recordAuthType": 0,
            "confConfigInfo": {
                "prolongLength": 15,
                "isGuestFreePwd": false,
                "isSendNotify": true,
                "isSendSms": true,
                "isAutoMute": true,
                "isSendCalendar": true,
                "callInRestriction": 0,
                "allowGuestStartConf": true,
                "isHardTerminalAutoMute": true,
                "enableWaitingRoom": true
            },
            "vmrFlag": 0,
            "scheduleVmr": false,
            "isHasRecordFile": false,
            "partAttendeeInfo": [
                {
                    "phone": "+99111****380",
                    "name": "user8002",
                    "type": "normal"
                }
            ],
            "terminlCount": 0,
            "normalCount": 1,
            "deptName": "wangyue",
            "confUUID": "6d2a6cd90a5b11eaa5e8f14973e50d03"
        }
    ],
    "offset": 0,
    "limit": 20,
    "count": 3
}

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/conferences/history?startDate=1574092800000&endDate=1574179199999'
Parent topic: APIs