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

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

入门使用

查询在线会议信息

更新时间:2019-11-19

描述

管理员或普通用户可以通过该接口查询指定在线会议详情。管理员可以查询管理权限域内所有的会议,普通用户仅能查询当前自己的帐号管理的会议。

接口原型

表1 接口原型

请求方法

GET

请求地址

/conferences/{conferenceid}/online

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

conferenceid

String

URL

会议标识。

pageIndex

Int

URL

指定返回的与会者列表的页面索引。该值必须大于0。

默认为“1”

pageSize

Int

URL

指定返回的与会者记录数。默认值由会议AS定义。

condition

String

URL

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

Authorization

String

Header

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

样例:Basic Base64(accessToken)

type

Int

Header

  • 0:不区分终端和与会人。
  • 1:分页查询区分终端和与会人,结果合并返回。
  • 2:单独查询终端和与会人,结果单独返回。

默认值为“0”

queryType

Int

Header

“type”“2”时,该字段有效。

  • 0:查询与会人。
  • 1:查询终端。

默认值为“0”

响应参数

表3 参数说明

参数

类型

描述

returnCode

Int

返回码。

returnDesc

String

返回描述。

data

ConferenceDetail

会议详细信息。

请求消息示例

GET /conferences/914018507/online?pageIndex=1&pageSize=5
Connection: keep-alive
Authorization: Basic UlBFUmR2Sk80TEV5bXNzam02WVh2bGY1RXduUnNKU2dY
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:58:52 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 1394
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 1e4af24ea29c6641dd73e3a6a027f007
Server: api-gateway
X-Request-Id: 696def7842d59349fd7e33319dce3e21

{
    "returnCode": 0,
    "returnDesc": "Success",
    "data": {
        "conferenceData": {
            "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"
        },
        "data": {
            "pageIndex": 1,
            "pageSize": 5,
            "totalCount": 0,
            "countTotal": false,
            "totalPages": 0,
            "lastPage": false,
            "nextPage": 0,
            "firstPage": false,
            "prePage": 0,
            "orderBySetted": false,
            "offset": 0,
            "data": []
        }
    }
}
 

CURL命令示例

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