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

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

入门使用

查询会议信息

更新时间:2019-11-19

描述

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

接口原型

表1 接口原型

请求方法

GET

请求地址

/conferences/{conferenceid}

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

conferenceid

String

URL

会议标识。

pageIndex

Int

URL

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

默认为“1”

pageSize

Int

URL

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

condition

String

URL

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

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

会议详细信息。

表4 ConferenceDetail 数据结构

参数

类型

描述

conferenceData

ConferenceInfo

会议信息。

data

PageParticipant

与会者列表。

表5 PageParticipant 数据结构

参数

类型

描述

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

ParticipantInfo[0..*]

与会者信息。

表6 ParticipantInfo 数据结构

参数

类型

描述

participantID

String

呼叫的号码。

name

String

与会者的名称(昵称)。

subscriberID

String

与会者的号码。

role

Int

会议中的角色。

  • 1:会议主席。
  • 0:普通与会者。

state

String

用户状态。目前固定返回MEETTING。

address

String

“Attendee”中的address。

attendeeType

String

默认值由会议AS定义。

  • “normal”:语音、高清、标清与会者地址(默认)。
  • “telepresence”:智真与会者地址类型,单屏、三屏智真均属此类。(预留字段)
  • “terminal”:会议室或硬终端。
  • “outside”:外部与会人。
  • “mobile”:软终端用户手机。
  • “telephone”:软终端用户固定电话。

phone2

String

“attendeeType”“telepresence”时,且设备为三屏智真,则该字段填写左屏号码。(预留字段)

phone3

String

“attendeeType”“telepresence”时,且设备为三屏智真,则该字段填写右屏号码。(预留字段)

email

String

邮件地址。最大不超过255个字符。

sms

String

短信通知的手机号码。最大不超过127个字符。

deptName

String

组织名称。最大不超过96个字符。

请求消息示例

GET /conferences/914026152
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:44:34 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 1811
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: acf5bd2cc7c7f90fe7ab6b95a8c753d5
Server: api-gateway
X-Request-Id: e2bc0a1429cb2fd52db88ba6fa2c44a8

{
    "returnCode": 0,
    "returnDesc": "Success",
    "data": 
    {
        "conferenceData": 
        {
            "conferenceID": "914026152",
            "mediaTypes": "Data,Voice",
            "subject": "user01的会议",
            "size": 1,
            "timeZoneID": "56",
            "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": 0,
                "isMute": 0,
                "type": "normal"
            }],
            "vmrFlag": 0,
            "scheduleVmr": false,
            "isHasRecordFile": false,
            "terminlCount": 0,
            "normalCount": 0,
            "deptName": "huawei_ffl "
        },
        "data": 
        {
            "pageIndex": 1,
            "pageSize": 20,
            "totalCount": 2,
            "totalPages": 0,
            "nextPage": 0,
            "prePage": 0,
            "offset": 0,
            "data": [
            {
                "participantID": "+8657*******",
                "name": "user02",
                "role": 1,
                "state": "MEETTING",
                "isMute": 0,
                "isDeaf": 0,
                "allowVideo": 0,
                "isRollcalled": 0,
                "hasTokenRing": 0,
                "isShare": 0,
                "isBroadcast": 0,
                "attendeeType": "normal",
                "accountId": "user02",
                "deptName": "huawei_ffl "
            },
            {
                "participantID": "+8657*******",
                "name": "user01",
                "role": 0,
                "state": "MEETTING",
                "isMute": 0,
                "isDeaf": 0,
                "allowVideo": 0,
                "isRollcalled": 0,
                "hasTokenRing": 0,
                "isShare": 0,
                "isBroadcast": 0,
                "attendeeType": "normal",
                "accountId": "user01",
                "deptName": "huawei_ffl "
            }]
        }
    }
}
 

CURL命令示例

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