Help Center/ Meeting/ Server API Reference/ Meeting Control/ APIs/ Querying Meeting Details in Real Time

Updated on 2024-01-19 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Meeting Details in Real Time

Description

This API is used to query details about an ongoing meeting in real time.

Debugging

You can debug this API in API Explorer.

Prototype

**Table 1** Prototype
Request Method	GET
Request Address	/v1/mmc/control/conferences/realTimeInfo
Transport Protocol	HTTPS

Request Parameters

**Table 2** Parameters
Parameter	Mandatory	Type	Location	Description
conferenceID	Yes	String	Query	Meeting ID.
X-Conference-Authorization	Yes	String	Header	Meeting control token, which can be obtained by calling the API for obtaining a meeting control token.

Status Codes

**Table 3** Status codes
HTTP Status Code	Description
200	Operation successful.
400	Invalid parameters.
500	Server exception.

Response Parameters

**Table 4** Response parameters
Parameter	Type	Description
attendees	Array of attendee objects	Information about participants invited during meeting scheduling and participants invited by the host during the meeting. The information about online and absent participants is returned.
participants	Array of participant objects	List of online participants, including participants who have joined the meeting, are being called, and are joining the meeting. NOTE: When an account joins a meeting on different types of terminals (such as mobile phones and PCs), the account is counted as an online participant on each terminal. Participants who have not joined or have left the meeting are not displayed in the online participant list.
confInfo	confInfo object	Ongoing meeting information.

**Table 5** attendee data structure
Parameter	Type	Description
accountID	String	Huawei Cloud Meeting account of the participant.
userUUID	String	Participant UUID.
name	String	Participant name.
phone	String	Participant number.
phoneLeft	String	Number of the left screen when the device is a triple-screen telepresence device. NOTE: This parameter will be discarded. Do not use it.
phoneRight	String	Number of the right screen when the device is a triple-screen telepresence device. NOTE: This parameter will be discarded. Do not use it.

**Table 6** participant data structure
Parameter	Type	Description
pid	String	Participant ID.
name	String	Participant name.
phone	String	Participant number.
state	Integer	User status. 0: The participant is in the meeting. 1: The participant is being called. 2: The participant is joining the meeting. NOTE: Participants who have not joined the meeting or have left the meeting are not displayed in the online participant list.
video	Integer	Audio or video. 0: audio. 1: video.
mute	Integer	Microphone status. 0: enabled. 1: disabled.
hand	Integer	Hand raising status of a participant. 0: The participant is not raising hands. 1: The participant is raising hands.

**Table 7** confInfo data structure
Parameter	Type	Description
chairID	String	Host ID.

Example Request

GET /v1/mmc/control/conferences/realTimeInfo?conferenceID=914083136
Connection: keep-alive
X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_131)

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 521
Connection: keep-alive
Server: api-gateway
http_proxy_id: b32bf70a8ac93ea13691fc34730fd78c

{
    "attendees": [
        {
            "accountID": "user01",
            "name": "user01",
            "phone": "+99111****815"
        }
    ],
    "participants": [
        {
            "pid": "a6b4e988216c11eabc516bc3a3d8d6c4",
            "name": "user01",
            "phone": "+99111****815",
            "state": 0,
            "video": 1,
            "mute": 1,
            "hand": 0
        }
    ],
    "confInfo": {}
}

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-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/realTimeInfo?conferenceID=914083136

Parent topic: APIs

Previous topic: Obtaining a Meeting Control Token

Next topic: Inviting Participants