文档首页 > > 服务端API参考> 会议管理> 接口参考> 查询会议列表

查询会议列表

分享
更新时间: 2019/09/02 GMT+08:00

描述

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

接口原型

表1 接口原型

请求方法

GET

请求地址

/conferences

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

userUUID

String

URL

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

说明:

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

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

pageIndex

Int

URL

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

默认为“1”

pageSize

Int

URL

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

queryAll

Boolean

URL

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

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

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

status

Int

URL

  • 0:查询待召开的和已召开的。
  • 1:查询待召开的。
  • 2:查询已召开的。

condition

String

URL

查询用来当作关键词的字符串。长度限制为1-128个字符。

queryConfMode

String

URL

  • ADAY:一天。
  • AWEEK:一周。
  • AMONTH:一个月。
  • ALL:查询所有。

sortType

String

URL

  • ASC_StartTIME:按会议开始时间升序排序。
  • DSC_StartTIME:按会议开始时间降序排序。
  • ASC_RecordTYPE:按会议是否有录播文件排序,之后默认按照会议开始时间升序排序。
  • DSC_RecordTYPE:按会议是否有录播文件排序,之后默认按照会议开始时间降序排序。

Authorization

String

Header

授权令牌。将执行鉴权响应的accessToken

进行Base64转码操作

样例:Basic Base64(accessToken)

响应参数

表3 参数说明

参数

类型

描述

returnCode

Int

返回码。

returnDesc

String

返回描述。

data

pageConferenceInfo

会议信息列表。

表4 pageConferenceInfo 数据结构

pageIndex

Int

第几页。

pageSize

Int

每页的记录数。

totalCount

Int

总记录数。

countTotal

Boolean

取值:

  • true
  • false

totalPages

Int

总页数。

lastPage

Boolean

是否是最后一页。取值:

  • true
  • false

nextPage

Int

下一页是第几页。

firstPage

Boolean

是否是第一页。取值:

  • true
  • false

prePage

Int

上一页是第几页。

sort

String[0..*]

排序字段。

orderBySetted

Boolean

是否设置排序字段。取值:

  • true
  • false

offset

Int

记录数偏移,这一页之前共有多少条。

data

ConferenceInfo[0..*]

会议信息列表。

请求消息示例

GET /conferences?pageIndex=1&pageSize=2
Connection: keep-alive
Authorization: Basic VFZQdG9tOUcwN2NMWGhMQ1phaXpRUDFsNkdlUzVvT05Q
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: Sat, 09 Mar 2019 06:47:01 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 2450
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 6fba0eff9f832b463580fb06c5b0ff9c
Server: api-gateway
X-Request-Id: ac9f75ec3c97c823f128526a924532b2

{
    "returnCode": 0,
    "returnDesc": "Success",
    "data": 
    {
        "pageIndex": 1,
        "pageSize": 2,
        "totalCount": 6,
        "countTotal": true,
        "totalPages": 3,
        "lastPage": false,
        "nextPage": 2,
        "firstPage": true,
        "prePage": 0,
        "orderBySetted": false,
        "offset": 0,
        "data": [
        {
            "conferenceID": "914026152",
            "mediaTypes": "Data,Voice",
            "subject": "user01的会议",
            "size": 1,
            "startTime": "2019-03-09 06:42",
            "endTime": "2019-03-09 08:42",
            "conferenceState": "Created",
            "accessNumber": "+8657*******",
            "language": "zh-CN",
            "passwordEntry": [{
                "conferenceRole": "chair",
                "password": "249410"
            },
            {
                "conferenceRole": "general",
                "password": "125641"
            }],
            "userUUID": "ff8080816933ab4801694865840a00c2",
            "scheduserName": "user01",
            "multiStreamFlag": 0,
            "conferenceType": 0,
            "isAutoMute": 0,
            "isAutoRecord": 0,
            "chairJoinUri": "https://nmeeting.huaweicloud.com:38443/portal/j/914026152?p=f624660633647a87aa51a8adbd133668e082a56e7bd846e0",
            "guestJoinUri": "https://nmeeting.huaweicloud.com:38443/portal/j/914026152?p=f5d9ae64af8c306823840288df538e88c40e51aeeb8d465c",
            "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": "+8657*******",
                "name": "user01",
                "role": 1,
                "isMute": 0,
                "type": "normal"
            }],
            "vmrFlag": 0,
            "scheduleVmr": false,
            "isHasRecordFile": false,
            "terminlCount": 0,
            "normalCount": 0,
            "deptName": "huawei_ffl ",
            "confUUID": "7ab2dc04423611e9b745f3df1cc2b59d"
        },
        {
            "conferenceID": "914027377",
            "mediaTypes": "Data,Voice",
            "subject": "user01的会议",
            "size": 1,
            "startTime": "2019-03-09 09:30",
            "endTime": "2019-03-09 11:30",
            "conferenceState": "Schedule",
            "accessNumber": "+8657*******",
            "language": "zh-CN",
            "passwordEntry": [
            {
                "conferenceRole": "chair",
                "password": "779901"
            },
            {
                "conferenceRole": "general",
                "password": "439258"
            }],
            "userUUID": "ff8080816933ab4801694865840a00c2",
            "scheduserName": "user01",
            "multiStreamFlag": 0,
            "conferenceType": 0,
            "isAutoMute": 0,
            "isAutoRecord": 0,
            "chairJoinUri": "https://nmeeting.huaweicloud.com:38443/portal/j/914027377?p=756d678c1f0ed03985fc9828a17f47105f5bc2cef5a759c0",
            "guestJoinUri": "https://nmeeting.huaweicloud.com:38443/portal/j/914027377?p=df4137c7be1e1584f74c124bf25621e91181e0ad2aea8767",
            "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": "+8657*******",
                "name": "user01",
                "role": 0,
                "isMute": 0,
                "type": "normal"
            }],
            "vmrFlag": 0,
            "scheduleVmr": false,
            "isHasRecordFile": false,
            "terminlCount": 0,
            "normalCount": 0,
            "deptName": "huawei_ffl ",
            "confUUID": "0abc19e83fe911e9b6b5c1e119aed030",
        }]
    }
}

CURL命令示例

curl -k -i -X GET -H 'Authorization:Basic T2FmNUppeGxvYms0MkZ4am45ZmdPR0dBOE1EYVZtMFBP' https://api.meeting.huaweicloud.com/conferences
分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区