文档首页/ 华为云会议 Meeting/ 服务端API参考/ 会议控制/ 接口参考/ 查询会议实时信息
更新时间：2024-04-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询会议实时信息

描述

该接口用于查询正在召开的会议实时信息。

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/mmc/control/conferences/realTimeInfo

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

conferenceID

是

String

Query

会议ID。

X-Conference-Authorization

是

String

Header

会控Token，通过获取会控token接口获得。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

500

服务端异常。

响应参数

表4 响应参数

参数

类型

描述

attendees

Array of attendee objects

被邀请与会者信息，包括预约会议时邀请的与会者和会中主持人邀请的与会者，已经加入会议的和未加入会议的都返回。

participants

Array of participant objects

在线与会者列表信息，包括已加入会议、被邀请正在呼叫中、正在加入会议的与会者列表等。

说明：
  • 同一个账号用不同类型终端（手机端或者PC端等）加入会议时，是不同的在线与会者
  • 未加入或者已离会与会者，不在在线与会者列表中

confInfo

confInfo object

在线会议信息。
表5 attendee数据结构说明

参数

类型

描述

accountID

String

与会者的华为云会议账号。

userUUID

String

与会者的用户UUID。

name

String

与会者名称。

phone

String

与会者号码。

phoneLeft

String

设备为三屏智真时的左屏号码。

说明：

该参数将废弃，请勿使用。

phoneRight

String

设备为三屏智真时的右屏号码。

说明：

该参数将废弃，请勿使用。
表6 participant数据结构说明

参数

类型

描述

pid

String

与会者标识。

name

String

与会者名称。

phone

String

与会者号码。

state

Integer

用户状态。

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

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

video

Integer

音视频能力。

  • 0：音频
  • 1：视频

mute

Integer

麦克风状态。

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

hand

Integer

与会者举手状态。

  • 0：未举手
  • 1：举手
表7 confInfo数据结构说明

参数

类型

描述

chairID

String

主持人与会者标识。

请求消息示例

GET /v1/mmc/control/conferences/realTimeInfo?conferenceID=914083136
Connection: keep-alive
X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_131)

响应消息示例

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 521
Connection: keep-alive
Server: api-gateway
http_proxy_id: b32bf70a8ac93ea13691fc34730fd78c

{
    "attendees": [
        {
            "accountID": "user01",
            "name": "user01",
            "phone": "+99111****815"
        }
    ],
    "participants": [
        {
            "pid": "a6b4e988216c11eabc516bc3a3d8d6c4",
            "name": "user01",
            "phone": "+99111****815",
            "state": 0,
            "video": 1,
            "mute": 1,
            "hand": 0
        }
    ],
    "confInfo": {}
}

错误码

当您使用华为云会议服务端API时，如果遇到“MMC”或者“USG”开头的错误码，请参考华为云API错误中心。

CURL命令示例

curl -k -i -X GET -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/realTimeInfo?conferenceID=914083136
父主题： 接口参考