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

Querying the Meeting List

Description

This API is used to query meetings that have not ended.

  • Administrators can query all meetings in the enterprise. Common users can query only meetings created by themselves or meetings which they are invited to. If no query parameter is carried, ongoing meetings and meeting that have not started are queried by default.
  • You can query only ongoing and upcoming meetings. For details about how to query historical meetings, see Querying the Historical Meeting List.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

GET

Request Address

/v1/mmc/management/conferences

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 meeting list of other users in the enterprise. For a common user, this parameter is invalid. Common users can query only meetings 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. Default value: false.

  • true: Query meetings of all users.
  • false: Query only meetings created by 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. The value can contain 1 to 128 characters.

queryConfMode

No

String

Query

Time range specified for query.

  • ADAY: Records of the previous day will be queried.
  • AWEEK: Records of the previous week will be queried.
  • AMONTH: Records of the previous month will be queried.
  • ALL: All the records will be queried.

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

Meeting list.

Example Request

GET /v1/mmc/management/conferences
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: 2450
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 6fba0eff9f832b463580fb06c5b0ff9c
Server: api-gateway
X-Request-Id: ac9f75ec3c97c823f128526a924532b2

{
    "data": [
        {
            "conferenceID": "914083136",
            "mediaTypes": "Data,Video,Voice",
            "subject": "user01's meeting",
            "size": 1,
            "timeZoneID": "56",
            "startTime": "2019-12-18 07:28",
            "endTime": "2019-12-18 09:28",
            "conferenceState": "Created",
            "accessNumber": "+991117",
            "language": "zh-CN",
            "passwordEntry": [
                {
                    "conferenceRole": "chair",
                    "password": "******"
                },
                {
                    "conferenceRole": "general",
                    "password": "******"
                }
            ],
            "userUUID": "ff808081699b56cb0169be103500012b",
            "scheduserName": "user8002",
            "multiStreamFlag": 1,
            "conferenceType": 0,
            "confType": "IMMEDIATELY",
            "isAutoMute": 1,
            "isAutoRecord": 0,
            "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/6a30b8b5a325105da031442627828e496f91021ece36405f",
            "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/9505dc3349228b1ce0db8165590cc977bcff89785130fe0d",
            "recordType": 0,
            "recordAuxStream": 0,
            "confConfigInfo": {
                "isSendNotify": true,
                "isSendSms": true,
                "isAutoMute": true
            },
            "vmrFlag": 0,
            "scheduleVmr": false,
            "isHasRecordFile": false,
            "partAttendeeInfo": [
                {
                    "phone": "+99111*****815",
                    "name": "user01",
                    "role": 0,
                    "isMute": 0,
                    "type": "normal"
                }
            ],
            "terminlCount": 0,
            "normalCount": 1,
            "deptName": "wangyue",
            "confUUID": "050c7898216811eaa6958bf3bb9ac167"
        }
    ],
    "offset": 0,
    "limit": 20,
    "count": 1
}

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
Parent topic: APIs