Querying Meeting Details
Description
This API is used to query details about a specific meeting.
- Administrators can query details about all meetings in the enterprise. Common users can query details about only meetings created by themselves or meetings which they are invited to.
- You can query only ongoing and upcoming meetings. For details about how to query details about a historical meeting, see Viewing Historical Meeting Details.
Debugging
You can debug this API in API Explorer.
URI
GET /v1/mmc/management/conferences/confDetail
Request 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. The default value is 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.
|
X-Query-Type |
No |
Integer |
Header |
This parameter is valid only when X-Type is set to 2. Default value: 0
|
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
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
Parameter |
Type |
Description |
---|---|---|
conferenceData |
ConferenceInfo object |
Meeting details. |
data |
PageParticipant object |
Participant list. |
Parameter |
Type |
Description |
---|---|---|
limit |
Integer |
Number of records on each page. |
count |
Integer |
Total number of records. |
offset |
Integer |
Query offset. |
data |
Array of ParticipantInfo objects |
Information about participants invited during meeting scheduling and invited by the host during the meeting.
NOTE:
|
Parameter |
Type |
Description |
---|---|---|
participantID |
String |
Participant ID. |
name |
String |
Participant name. |
subscriberID |
String |
Number of the participant. This field is reserved. |
role |
Integer |
Participant role.
|
state |
String |
User status. Currently, the value is fixed to MEETTING. |
address |
String |
Information about the meeting room where the terminal is located. This field is reserved. |
attendeeType |
String |
Terminal type of the participant.
|
accountId |
String |
Participant account.
|
phone2 |
String |
Reserved field. |
phone3 |
String |
Reserved field. |
|
String |
Email address. |
sms |
String |
Mobile number for receiving SMS notifications. |
deptName |
String |
Department name. |
userUUID |
String |
UUID of the user who schedules the meeting. |
appId |
String |
App ID. For details, see Requesting an App ID. |
isAutoInvite |
Integer |
Whether to automatically invite participants when the meeting starts. The default value is defined in the enterprise-level configuration.
NOTE:
This parameter is valid only for meetings held using concurrent participant resources and a random ID. |
isNotOverlayPidName |
Boolean |
Whether the participant name is not superimposed (applicable to the VDC scenario).
|
Example Request
- Ordinary meeting
GET /v1/mmc/management/conferences/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)
- Recurring meeting
GET /v1/mmc/management/conferences/confDetail?conferenceID=969304019 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
- Ordinary meeting
HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1811 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: acf5bd2cc7c7f90fe7ab6b95a8c753d5 Server: api-gateway X-Request-Id: e2bc0a1429cb2fd52db88ba6fa2c44a8 { "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": { "isSendNotify": true, "isSendSms": true, "isAutoMute": 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" } ] } }
- Recurring meeting
HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1811 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: acf5bd2cc7c7f90fe7ab6b95a8c753d5 Server: api-gateway X-Request-Id: e2bc0a1429cb2fd52db88ba6fa2c44a8 { "conferenceData": { "conferenceID": "969304019", "mediaTypes": "Voice,Data,Video", "subject": "user01's meeting", "size": 1, "timeZoneID": "56", "startTime": "2019-12-18 07:28", "endTime": "2019-12-18 09:28", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "******" }, { "conferenceRole": "general", "password": "******" } ], "userUUID": "ff808081699b56cb0169be103500012b", "scheduserName": "user8002", "multiStreamFlag": 1, "conferenceType": 2, "confType": "CYCLE", "cycleParams": { "startDate": "2019-12-18", "cycle": "Day", "endDate": "2019-12-19", "interval": 1 }, "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, "subConfs": [ { "cycleSubConfID": "84bfd3816e744b81a02d76a5537a49dc", "conferenceID": "969304019", "mediaType": "Voice,Data,HDVideo", "startTime": "2019-12-18 07:28", "endTime": "2019-12-18 09:28", "isAutoRecord": 0, "confConfigInfo": { "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "joinBeforeHostTime": 0, "enableWaitingRoom": true } }, { "cycleSubConfID": "2e447d1e012c49d9b682ea6af73b6fa6", "conferenceID": "969304019", "mediaType": "Voice,Data,HDVideo", "startTime": "2019-12-18 07:28", "endTime": "2019-12-18 09:28", "isAutoRecord": 0, "confConfigInfo": { "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "joinBeforeHostTime": 0, "enableWaitingRoom": true } }], "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/confDetail?conferenceID=914083136'
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot