Help Center/ Meeting/ Server API Reference/ Cloud Meeting Room Management/ Querying Cloud Meeting Rooms by Page and the Personal Meeting ID as a Common User

Updated on 2023-12-22 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Cloud Meeting Rooms by Page and the Personal Meeting ID as a Common User

Description

This API is used by an enterprise user to query cloud meeting rooms allocated to the user and the personal meeting ID.

Debugging

You can debug this API in API Explorer.

Prototype

**Table 1** Prototype
Request Method	GET
Request Address	/v1/usg/dcs/member/vmr
Transport Protocol	HTTPS

Request Parameters

**Table 2** 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 by cloud meeting room name or ID is supported.
specialVmr	No	Boolean	Query	Type of cloud meeting rooms to be queried. If this parameter is left empty, all types are queried. false: personal meeting ID. true: cloud meeting room.
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

**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
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 QueryVmrResultDTO objects	List of cloud meeting rooms.

**Table 5** QueryVmrResultDTO data structure
Parameter	Type	Description
allowGustFirst	Boolean	Whether guests are allowed to join the cloud meeting room ahead of the host.
chairJoinUrl	String	Link for the host to join the meeting.
chairPwd	String	Host password.
gustFirstNotice	Boolean	Whether to notify the cloud meeting room owner after the cloud meeting room is used.
gustJoinUrl	String	Link for guests to join the meeting.
gustPwd	String	Guest password.
id	String	Cloud meeting room ID. NOTE: It matches vmrID in the API for creating a meeting.
status	Integer	Cloud meeting room status. 0: normal. 1: disabled. 2: unallocated.
vmrMode	Integer	Cloud meeting room mode. 0: personal meeting ID. 1: cloud meeting room. 2: webinar.
vmrId	String	Fixed meeting ID of the cloud meeting room or personal meeting ID. NOTE: It matches vmrConferenceID in the response of calling the API for creating a meeting.
vmrName	String	Cloud meeting room name.
vmrPkgId	String	ID of the cloud meeting room package. This parameter is returned only for cloud meeting rooms.
vmrPkgName	String	Name of the cloud meeting room package. This parameter is returned only for cloud meeting rooms.
vmrPkgParties	Integer	Number of concurrent participants in the cloud meeting room package. This parameter is returned only for cloud meeting rooms.

Example Request

GET /v1/usg/dcs/member/vmr?specialVmr=true&offset=0&limit=10
Connection: keep-alive
X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF
Content-Type: application/json
Content-Length: 94
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: 143
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: fbbc91569f0efed914e0427fc2a9c4ac 

{
   "count" : 1,
   "data" : [
      {
         "allowGustFirst" : true,
         "chairJoinUrl" : "https://bmeeting.huaweicloud.com/#/j/9******5/4***************0",
         "chairPwd" : "******",
         "gustFirstNotice" : false,
         "gustJoinUrl" : "https://bmeeting.huaweicloud.com/#/j/9******5",
         "gustPwd" : null,
         "id" : "ff80808167ef1ef50167f060f574139a",
         "status" : 0,
         "vmrId" : "938305104",
         "vmrMode" : 0,
         "vmrName" : "Cloud Meeting Room 5104",
         "vmrPkgId" : "ff80808167e5f5aa0167e627ed970002",
         "vmrPkgName" : "Large Cloud Meeting Room-50 Participants",
         "vmrPkgParties" : 25
      }
   ],
   "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 "content-type:application/json"  -H "X-Access-Token:cnrR5zgAjyIhNeDpfa7iDr8bYmYvN0k8q4iZ" "https://api.meeting.huaweicloud.com/v1/usg/dcs/member/vmr?specialVmr=true&offset=0&limit=10"

Parent topic: Cloud Meeting Room Management

Previous topic: Querying Cloud Meeting Rooms by Page as an Enterprise Administrator

Next topic: Modifying Cloud Meeting Room and Personal Meeting ID Information