Querying Cloud Meeting Rooms by Page as an Enterprise Administrator
Description
This API is used by an enterprise administrator to query cloud meeting rooms in the enterprise by page.
Debugging
You can debug this API in API Explorer.
Prototype
Request Method |
GET |
---|---|
Request Address |
/v1/usg/dcs/corp/vmr |
Transport Protocol |
HTTPS |
Request Parameters
Parameter |
Mandatory |
Type |
Location |
Description |
---|---|---|---|---|
offset |
No |
Integer |
Query |
Query offset. If the value exceeds the maximum number of records available, records on the last page are returned. Default value: 0. |
limit |
No |
Integer |
Query |
Number of records to query. Default value: 100. |
searchKey |
No |
String |
Query |
Search criteria. Fuzzy search based on the cloud meeting room name, cloud meeting room ID, and name of the user or hard terminal that the cloud meeting room is allocated to is supported. |
status |
No |
Integer |
Query |
Cloud meeting room status. If this parameter is left empty, all records are queried.
|
vmrMode |
No |
Integer |
Query |
Cloud meeting room mode. If this parameter is left blank, the mode is cloud meeting room by default.
|
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-Request-Id |
No |
String |
Header |
Request ID, which is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated. |
Accept-Language |
No |
String |
Header |
Language. Values: zh-CN for Chinese (default) and en-US for English. |
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 |
---|---|---|
count |
Integer |
Total number of records. |
limit |
Integer |
Number of records displayed per page. Default value: 10. |
offset |
Integer |
Number of the query start page. The value starts from 0. |
data |
Array of QueryOrgVmrResultDTO objects |
List of cloud meeting rooms. |
Parameter |
Type |
Description |
---|---|---|
device |
IdMarkDTO object |
Huawei Cloud Meeting account of the hard terminal bound to the cloud meeting room. |
id |
String |
Cloud meeting room ID.
NOTE:
It matches vmrID in the API for creating a meeting. |
member |
IdMarkDTO object |
Huawei Cloud Meeting account of the user bound to the cloud meeting room. |
status |
Integer |
Cloud meeting room status.
|
vmrId |
String |
Fixed meeting ID of the cloud meeting room.
NOTE:
It matches vmrConferenceID in the response of calling the API for creating a meeting. |
vmrName |
String |
Cloud meeting room name. |
vmrPkgName |
String |
Cloud meeting room package name. |
vmrPkgParties |
Integer |
Number of concurrent participants in the cloud meeting room package. |
maxAudienceParties |
Integer |
Maximum number of attendees (valid only for webinars). |
expireDate |
Long |
Expiration timestamp, in milliseconds. |
commercialMaxAudienceParties |
Integer |
Maximum number of attendees in commercial specifications (valid only for webinars). |
Example Request
GET /v1/usg/dcs/corp/vmr?searchKey=6767&offset=0&limit=10 Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json 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: 308 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: fbbc91569f0efed914e0427fc2a9c4ac { "count" : 1, "data" : [ { "device" : { "id" : "22c1804004374b558084c50e44e77085", "mark" : "13456789" }, "id" : "ff8080816c52e2a6016c53878f030030", "member" : { "id" : "nhl", "mark" : "nhl(nhl)" }, "status" : 0, "vmrId" : "9*******7", "vmrName" : "Cloud meeting room", "vmrPkgName" : "Small cloud meeting room-10 participants", "vmrPkgParties" : 10, "maxAudienceParties": 1000, "commercialMaxAudienceParties": 1000, "expireDate": 1666195200000 } ], "limit" : 10, "offset" : 0 }
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 -v -X GET -H "X-Access-Token:cnrYgnb27xFYyyYu4HNdmZ0zJL8WcKc3M6ir" "https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/vmr?searchKey=6767&offset=0&limit=10"
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