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

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

入门使用

查询会议实时信息

更新时间：2019-11-19

描述

会议主席可以通过该接口查询会议的实时信息。

接口原型

表1 接口原型

请求方法

GET

请求地址

/cms/open/rest/confctl/{conferenceid}/realTimeInfo

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

conferenceid

是

String

URL

会议标识。

Conference-Authorization

是

String

Header

会控授权令牌(通过会议ID/密码登录会议控制获取)，将响应的token进行Base64转码操作。

样例：Basic Base64(token)

响应参数

表3 参数说明

参数

类型

描述

returnCode

Int

返回码。

returnDesc

String

返回描述。

attendees

RealTimeAttendee[0..*]

所有参加会议的与会者列表，包括未入会的以及在线的与会者信息。

participants

RealTimeParticipant[0..*]

在线会场列表，包括已进入会议、呼叫中、正在加入会议的与会者列表等。

confInfo

RealTimeConfInfo

会议信息。
表4 RealTimeAttendee 数据结构

参数

数据类型

描述

accountID

String

与会者帐号。

userUUID

String

与会者的用户uuid。

name

String

与会者名称或昵称，长度限制为96个字符。

phone

String

与会者设备的注册号码（可支持SIP、TEL号码格式）。最大不超过127个字符。

设备为三屏智真时的中屏号码（三屏智真为预留接口）。

phoneLeft

String

设备为三屏智真时的左屏号码（预留接口）。

phoneRight

String

设备为三屏智真时的右屏号码（预留接口）。
表5 RealTimeParticipant 数据结构

参数

数据类型

描述

pid

String

与会者的用户uuid。

name

String

与会者名称或昵称，长度限制为96个字符。

phone

String

与会者设备的注册号码（可支持SIP、TEL号码格式）。最大不超过127个字符。

state

Int

用户状态。各枚举值如下所示：

  • 0：会议中
  • 1：正在呼叫
  • 2：正在加入会议

若会场未入会或已离会，则不会显示于在线会场列表。

video

Int

音视频能力。

  • 0：音频
  • 1：视频

mute

Int

麦克风状态。

  • 0：麦克风打开
  • 1：麦克风关闭

hand

Int

与会者举手状态。

  • 0：未举手
  • 1：举手
表6 RealTimeConfInfo数据结构

参数

数据类型

描述

chairID

String

主席的用户uuid。

请求消息示例

GET /cms/open/rest/confctl/914015126/realTimeInfo
Connection: keep-alive
Conference-Authorization: Basic dG9rZW4xMDBiZjBjM2FiNThjMDhiYTQyNzEyOGVmZGZmMDJhOWM5MTEwNDEyNjRjZDU1ZjE=
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_131)
 

响应消息示例

HTTP/1.1 200 
Date: Thu, 27 Jun 2019 02:23:18 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 521
Connection: keep-alive
Server: api-gateway
http_proxy_id: b32bf70a8ac93ea13691fc34730fd78c

{
    "returnCode":0,
    "returnDesc":"Success",
    "attendees":[
    {
        "accountID":"test001",
        "userUUID":"6b1b0a6d39bf48f591bea41918b83fe8",
        "name":"test002",
        "phone":"+86571300590"
    },
    {
        "accountID":"test003",
        "userUUID":"fce9c37c9b3146e795fc624ba349d912",
        "name":"test003",
        "phone":"+86571383395"
    },
    {
        "accountID":"test007",
        "userUUID":"5abe94d4bad74c7090bacab9f834e87c",
        "name":"test008",
        "phone":"+86571319525"
    }],
    "participants":[
    {
        "name":"test008",
        "phone":"+86571319525",
        "state":0,
        "video":0,
        "mute":0,
        "hand":0,
        "pid":"e5fae9ad988111e98346bb3bca33b52d"
    }]
}
 

CURL命令示例

curl -k -i -X GET -H 'Conference-Authorization:Basic dG9rZW4xMDBiZjBjM2FiNThjMDhiYTQyNzEyOGVmZGZmMDJhOWM5MTEwNDEyNjRjZDU1ZjE=' https://api.meeting.huaweicloud.com/cms/open/rest/confctl/914015126/realTimeInfo