查询在线会议列表
描述
该接口用于查询正在召开的会议列表。管理员可以查询本企业内所有在线会议,普通用户仅能查询自己账号创建或者需要参加的在线会议。不带查询参数时,默认查询权限范围内的在线会议,按开始时间升序排列。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/mmc/management/conferences/online
请求参数
|
参数 |
是否必须 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
|
userUUID |
否 |
String |
Query |
用户UUID。
说明:
该参数将废弃,请勿使用。 |
|
offset |
否 |
Integer |
Query |
查询偏移量。默认为0。 |
|
limit |
否 |
Integer |
Query |
查询数量。默认是20,最大500条。 |
|
queryAll |
否 |
Boolean |
Query |
指定是否查询企业下所有用户的会议记录。默认值是false。
说明:
仅对企业管理员生效。 |
|
searchKey |
否 |
String |
Query |
查询条件 。会议主题、会议预约人和会议ID等可作为搜索内容。长度限制为1-128个字符。 |
|
X-Access-Token |
是 |
String |
Header |
授权令牌。获取“执行App ID鉴权”响应的accessToken。 |
|
X-Authorization-Type |
否 |
String |
Header |
标识是否为第三方portal过来的请求。
说明:
该参数将废弃,请勿使用。 |
|
X-Site-Id |
否 |
String |
Header |
用于区分到哪个HCSO站点鉴权。
说明:
该参数将废弃,请勿使用。 |
状态码
|
HTTP状态码 |
描述 |
|---|---|
|
200 |
操作成功。 |
|
400 |
参数异常。 |
|
401 |
未鉴权或鉴权失败。 |
|
403 |
权限受限。 |
|
500 |
服务端异常。 |
响应参数
|
参数 |
类型 |
描述 |
|---|---|---|
|
offset |
Integer |
查询偏移量。 |
|
limit |
Integer |
每页的记录数。 |
|
count |
Integer |
总记录数。 |
|
data |
Array of ConferenceInfo objects |
会议信息列表。 |
请求消息示例
GET /v1/mmc/management/conferences/online 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)
响应消息示例
HTTP/1.1 200
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 1410
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: afebdbf50a938b965304c57d5c15676a
Server: api-gateway
X-Request-Id: be9dc6ff2eba30835ca2a5dfe2c4914d
{
"data": [
{
"conferenceID": "914083136",
"mediaTypes": "Voice,Data,Video",
"subject": "user01的会议",
"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": {
"prolongLength": 15,
"isGuestFreePwd": false,
"isSendNotify": true,
"isSendSms": true,
"isAutoMute": true,
"isSendCalendar": true,
"callInRestriction": 0,
"allowGuestStartConf": true,
"isHardTerminalAutoMute": true,
"enableWaitingRoom": true
},
"vmrFlag": 0,
"scheduleVmr": false,
"isHasRecordFile": false,
"partAttendeeInfo": [
{
"phone": "+99111****815",
"name": "user01",
"type": "normal"
}
],
"terminlCount": 0,
"normalCount": 1,
"deptName": "wangyue",
"confUUID": "050c7898216811eaa6958bf3bb9ac167"
}
],
"offset": 0,
"limit": 20,
"count": 1
}
错误码
当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心。
CURL命令示例
curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' https://api.meeting.huaweicloud.com/v1/mmc/management/conferences/online