企业管理员分页查询企业云会议室
描述
企业管理员通过该接口分页查询企业的云会议室。
调试
您可以在API Explorer中调试该接口。
接口原型
请求方法 |
GET |
|---|---|
请求地址 |
/v1/usg/dcs/corp/vmr |
传输协议 |
HTTPS |
请求参数
参数 |
是否必须 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
offset |
否 |
Integer |
Query |
查询偏移量，若超过最大数量，则返回最后一页的数据。 默认值：0 |
limit |
否 |
Integer |
Query |
查询数量。 默认值：10 |
searchKey |
否 |
String |
Query |
搜索条件。支持云会议室名称、ID及分配的用户、硬终端名称模糊搜索。 |
status |
否 |
Integer |
Query |
云会议室状态。不填则查询所有。
|
vmrMode |
否 |
Integer |
Query |
VMR模式。不填则默认为云会议室。
|
X-Access-Token |
是 |
String |
Header |
授权令牌。获取“执行App ID鉴权”响应的accessToken。 |
X-Request-Id |
否 |
String |
Header |
请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 |
Accept-Language |
否 |
String |
Header |
语言参数，默认为中文zh-CN, 英文为en-US。 |
状态码
HTTP状态码 |
描述 |
|---|---|
200 |
操作成功。 |
400 |
参数异常。 |
401 |
未鉴权或鉴权失败。 |
403 |
权限受限。 |
500 |
服务端异常 |
响应参数
参数 |
类型 |
描述 |
|---|---|---|
count |
Integer |
总数量。 |
limit |
Integer |
每页显示的条目数量。 默认值：10 |
offset |
Integer |
页面起始页，从0开始。 |
data |
Array of QueryOrgVmrResultDTO objects |
查询到的云会议室列表。 |
参数 |
类型 |
描述 |
|---|---|---|
device |
IdMarkDTO object |
云会议室绑定硬终端的华为云会议账号。 |
id |
String |
云会议室的ID。
说明：
对应创建会议接口中的vmrID。 |
member |
IdMarkDTO object |
云会议室绑定用户的华为云会议账号。 |
status |
Integer |
云会议室状态。 0：正常 1：停用 2：未分配 |
vmrId |
String |
云会议室的固定会议ID。
说明：
对应创建会议接口返回数据的vmrConferenceID。 |
vmrName |
String |
云会议室名称。 |
vmrPkgName |
String |
云会议室套餐名称。 |
vmrPkgParties |
Integer |
云会议室套餐会议并发方数。 |
maxAudienceParties |
Integer |
最大观众与会方数(仅网络研讨会有效)。 |
expireDate |
Long |
到期时间的时间戳，单位毫秒。 |
commercialMaxAudienceParties |
Integer |
按次资源转商后,商用规格最大观众与会方数(仅网络研讨会有效)。 |
请求消息示例
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)
响应消息示例
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" : "云会议室",
"vmrPkgName" : "小型云会议室-10方",
"vmrPkgParties" : 10,
"maxAudienceParties": 1000,
"commercialMaxAudienceParties": 1000,
"expireDate": 1666195200000
}
],
"limit" : 10,
"offset" : 0
}
错误码
当您使用华为云会议服务端API时，如果遇到“MMC”或者“USG”开头的错误码，请参考华为云API错误中心。
CURL命令示例
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"
