文档首页/ 华为云会议 Meeting/ 服务端API参考/ 云会议室管理/ 普通用户分页查询云会议室及个人会议ID
更新时间:2023-12-29 GMT+08:00

普通用户分页查询云会议室及个人会议ID

描述

企业用户通过该接口查询个人已分配的云会议室及个人会议ID。

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/usg/dcs/member/vmr

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

offset

Integer

Query

查询偏移量,若超过最大数量,则返回最后一页的数据。

默认值:0

limit

Integer

Query

查询数量。

默认值:10

searchKey

String

Query

搜索条件。支持云会议室名称、ID模糊搜索。

specialVmr

Boolean

Query

查询VMR的类型。不填则查询所有类型。

false:个人会议ID

true:云会议室

X-Access-Token

String

Header

授权令牌。获取“执行App ID鉴权”响应的accessToken。

X-Request-Id

String

Header

请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。

Accept-Language

String

Header

语言参数,默认为中文zh-CN, 英文为en-US。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常

响应参数

表4 响应参数

参数

类型

描述

count

Integer

总数量。

limit

Integer

每页显示的条目数量。

默认值:10

offset

Integer

页面起始页,从0开始。

data

Array of QueryVmrResultDTO objects

查询到的云会议室列表。

表5 QueryVmrResultDTO数据结构

参数

类型

描述

allowGustFirst

Boolean

允许来宾先入会。

chairJoinUrl

String

主持人与会链接。

chairPwd

String

主持人密码。

gustFirstNotice

Boolean

云会议室被使用后是否通知会议室所有者。

gustJoinUrl

String

来宾与会链接。

gustPwd

String

来宾密码。

id

String

云会议室的ID。

说明:

对应创建会议接口中的vmrID。

status

Integer

云会议室状态。

0:正常

1:停用

2:未分配

vmrMode

Integer

VMR模式。

0:个人会议ID

1:云会议室

2:网络研讨会

vmrId

String

云会议室的固定会议ID或者个人会议ID。

说明:

对应创建会议接口返回数据的vmrConferenceID。

vmrName

String

云会议室名称。

vmrPkgId

String

云会议室套餐包的id,仅云会议室返回。

vmrPkgName

String

云会议室套餐包的名称,仅云会议室返回。

vmrPkgParties

Integer

云会议室套餐包的会议并发方数,仅云会议室返回。

请求消息示例

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)

响应消息示例

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" : "云会议室5104",
         "vmrPkgId" : "ff80808167e5f5aa0167e627ed970002",
         "vmrPkgName" : "大型云会议室-50方",
         "vmrPkgParties" : 25
      }
   ],
   "limit" : 10,
   "offset" : 0
}

错误码

当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心

CURL命令示例

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"