智慧服务,成就美好体验 项目咨询

主页 > 服务与支持 > 开发平台 > 服务端API参考 > 会议控制 > 接口参考 查询在线会议列表

入门使用

查询在线会议列表

更新时间:2019-11-19

描述

管理员或普通用户可以通过该接口查询会议列表。管理员可以查询管理权限域内所有的会议,普通用户仅能查询当前自己帐号管理的会议。不带查询参数时,默认查询权限范围内正在召开的会议,按开始时间升序排列。

接口原型

表1 接口原型

请求方法

GET

请求地址

/conferences/online

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

userUUID

String

URL

待查询的会议预定者的用户UUID。

说明:

仅管理员有权限查询权限范围内的所有帐号,普通帐号仅能查询自己的。

内置会议默认是登录帐号。

pageIndex

Int

URL

指定返回的页面索引。该值必须大于0。

默认为“1”

pageSize

Int

URL

指定返回的记录数。默认值由会议AS定义,默认是“20”,最大值为“500”

queryAll

Boolean

URL

指定是否查询企业下所有用户的会议记录。

如果登录帐号不是企业管理员,则该字段无效。

如果该字段为“true”,则“userUUID”字段无效。

condition

String

URL

查询用来当作关键词的字符串。

Authorization

String

Header

授权令牌。将执行鉴权响应的accessToken进行Base64转码操作

样例:Basic Base64(accessToken)

响应参数

表3 参数说明

参数

类型

描述

returnCode

Int

返回码。

returnDesc

String

返回描述。

data

pageConferenceInfo

会议信息列表。

请求消息示例

GET /conferences/online?pageIndex=1&pageSize=5
Connection: keep-alive
Authorization: Basic dVFpdlVnU1FEQzB0UDlOT3VWanNaYkJUZDBwRVA1ajd3
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, 10 Jul 2019 08:20:51 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

{
    "returnCode": 0,
    "returnDesc": "Success",
    "data": {
        "pageIndex": 1,
        "pageSize": 5,
        "totalCount": 1,
        "countTotal": true,
        "totalPages": 1,
        "lastPage": true,
        "nextPage": 2,
        "firstPage": true,
        "prePage": 0,
        "orderBySetted": false,
        "offset": 0,
        "data": [
            {
                "conferenceID": "914018507",
                "mediaTypes": "Data,Voice",
                "subject": "语音会议",
                "size": 1,
                "timeZoneID": "56",
                "startTime": "2019-07-10 08:00",
                "endTime": "2019-07-10 09:15",
                "conferenceState": "Created",
                "accessNumber": "+991119",
                "language": "zh-CN",
                "passwordEntry": [
                    {
                        "conferenceRole": "chair",
                        "password": "745814"
                    },
                    {
                        "conferenceRole": "general",
                        "password": "569768"
                    }
                ],
                "userUUID": "881c30b9781543d1862ca66f8a0e7b41",
                "scheduserName": "test002",
                "multiStreamFlag": 0,
                "conferenceType": 0,
                "isAutoMute": 1,
                "isAutoRecord": 0,
                "chairJoinUri": "https://nmeeting.huaweicloud.com/#/j/914018507/fa49efbc7f0ab0833b7f6cc5892c5cdc99eec645e6908318",
                "guestJoinUri": "https://nmeeting.huaweicloud.com/#/j/914018507/26ca29637369bce24845ffa73b902ff1e853a4260a6748de",
                "recordType": 0,
                "recordAuxStream": 0,
                "confConfigInfo": {
                    "inviteMode": "AUTO_INVITE",
                    "prolongLength": 15,
                    "dispatchMode": "AUTO_DISPATCH",
                    "isGuestFreePwd": false,
                    "isSendNotify": true,
                    "isSendSms": true,
                    "isAutoMute": true
                },
                "vmrFlag": 0,
                "scheduleVmr": false,
                "isHasRecordFile": false,
                "partAttendeeInfo": [
                    {
                        "phone": "+991116002971",
                        "name": "test002",
                        "role": 0,
                        "isMute": 0,
                        "type": "normal"
                    }
                ],
                "terminlCount": 0,
                "normalCount": 1,
                "deptName": "test001",
                "confUUID": "cbb9e294a2e811e98fc4651c4e204b42"
            }
        ]
    }
}
 

CURL命令示例

curl -k -i -X GET -H 'Authorization:Basic dVFpdlVnU1FEQzB0UDlOT3VWanNaYkJUZDBwRVA1ajd3' https://api.meeting.huaweicloud.com/conferences/online?pageIndex=1&pageSize=5