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

Querying Ongoing Meeting Details

Description

This API is used to query details about an ongoing meeting. Administrators can query details about all ongoing meetings in the enterprise. Common users can query details about only the ongoing meetings created by themselves or those they are invited to.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

GET

Request Address

/v1/mmc/management/conferences/online/confDetail

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

conferenceID

Yes

String

Query

Meeting ID.

NOTE:

conferenceID returned when a meeting is created. The value is not the value of vmrConferenceID.

offset

No

Integer

Query

Query offset. Default value: 0. This parameter is used to display PageParticipant data by page.

limit

No

Integer

Query

Number of records to query. Default value: 20.

searchKey

No

String

Query

Query condition. The value can contain 1 to 128 characters.

userUUID

No

String

Query

UUID of a user.

NOTE:

This parameter will be discarded. Do not use it.

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-Type

No

Integer

Header

Default value: 0.

  • 0: Do not distinguish terminals and participants.
  • 1: Distinguish terminals and participants in pagination query. The query results are combined and returned.
  • 2: Query terminals and participants and return the query results separately.

X-Query-Type

No

Integer

Header

This parameter is valid only when X-Type is set to 2. Default value: 0.

  • 0: Query participants.
  • 1: Query terminals.

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

conferenceData

ConferenceInfo object

Meeting details.

data

PageParticipant object

Information about invited participants, including those invited during meeting scheduling.

NOTE:
  • Information about participants who proactively join the meeting is not returned.

Example Request

GET /v1/mmc/management/conferences/online/confDetail?conferenceID=914083136
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: 1394
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 1e4af24ea29c6641dd73e3a6a027f007
Server: api-gateway
X-Request-Id: 696def7842d59349fd7e33319dce3e21

{
    "conferenceData": {
        "conferenceID": "914083136",
        "mediaTypes": "Voice,Data,Video",
        "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": {
            "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****815",
                "name": "user01",
                "type": "normal"
            }
        ],
        "terminlCount": 0,
        "normalCount": 1,
        "deptName": "wangyue",
        "confUUID": "050c7898216811eaa6958bf3bb9ac167"
    },
    "data": {
        "offset": 0,
        "limit": 20,
        "count": 1,
        "data": [
            {
                "participantID": "+991116003815",
                "name": "user01",
                "role": 0,
                "state": "MEETTING",
                "attendeeType": "normal",
                "accountId": "user01"
            }
        ]
    }
}

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/online/confDetail?conferenceID=914083136'
Parent topic: APIs