MAXHUB视频会议系统实时通知消息接口文档

1. 文档概述

本文档详细描述了MAXHUB视频会议系统的实时通知消息接口，用于服务器向客户端主动推送会议状态变更消息，包括但不限于：

终端入会/退会通知

会议模式变更

终端状态变化（静音/解除静音等）

2. WebSocket连接规范

2.1 连接地址

${serverURL}/{namespace}?endpointId=${endpointId}&accessToken=${accessToken}

2.2 连接参数

参数名	位置	必需	说明	示例值
namespace	URL路径	是	命名空间，用于区分不同功能模块	`meeting_confservice_v1`
endpointId	Query	是	终端唯一标识符	`bd30d88e-b9f0-4644-95c7-67ede794d0ae`
accessToken	Query	是	认证令牌，需有效	`fee11f53-f072-4d88-9cd3-25a0a4c5fb2f`

2.3 连接示例代码

3. 消息协议规范

3.1 会议控制消息

namespace: meeting_confservice_v1

endpointId: 进入会议后返回的 endpointId

3.1.1 加入会议通知

消息路由: meeting.confservice.room.join

消息体结构:

{
    "properties": {},
    "body": {
        "roomEndpointId": "11caf9ed-f24f-4bc3-98f9-93ab36c9ae28",
        "nickname": "昵称",
        "headImage": "头像",
        "platform": 5,
        "platformSubType": 1,
        "isMaster": false,
        "epId": "11caf9ed-f24f-4bc3-98f9-93ab36c9ae28",
        "options": {
            "isMute": true,
            "isVideoOff": true,
            "isSpeakerMute": false,
            "isLocalRecording": true
        },
        "userId": "11caf9ed-f24f-4bc3-98f9-93ab36c9ae28",
        "deviceId": "11caf9ed-f24f-4bc3-98f9-93ab36c9ae28",
        "disconnectTime": 1511097155000,
        "createdDate": 1511097155000,
        "updatedDate": 1511097155000,
        "platform": 5
    }
}

消息体描述：

字段名	类型	必需	描述	示例值/枚举值
`roomEndpointId`	string	是	终端在会议中的唯一标识符	`"11caf9ed-f24f-4bc3-98f9-93ab36c9ae28"`
`nickname`	string	是	用户昵称	`"昵称"`
`headImage`	string	否	用户头像URL（可为空或默认头像）	`"头像URL"`
`platform`	integer	是	终端平台类型代码	`5`
`platformSubType`	integer	否	平台子类型	`1`
`isMaster`	boolean	是	是否为主持人	`false`
`epId`	string	是	终端ID（与`roomEndpointId`可能重复，需确认差异）	`"11caf9ed-f24f-4bc3-98f9-93ab36c9ae28"`
`options.isMute`	boolean	是	麦克风是否静音	`true`
`options.isVideoOff`	boolean	是	摄像头是否关闭	`true`
`options.isSpeakerMute`	boolean	是	扬声器是否静音	`false`
`options.isLocalRecording`	boolean	是	是否正在本地录制	`true`
`userId`	string	是	用户唯一标识	`"11caf9ed-f24f-4bc3-98f9-93ab36c9ae28"`
`deviceId`	string	是	设备唯一标识	`"11caf9ed-f24f-4bc3-98f9-93ab36c9ae28"`
`disconnectTime`	long	否	上次断开时间（Unix时间戳，毫秒）	`1511097155000`
`createdDate`	long	是	终端创建时间（Unix时间戳，毫秒）	`1511097155000`
`updatedDate`	long	是	终端最后更新时间（Unix时间戳，毫秒）	`1511097155000`

3.1.2 会议模式变更通知

消息路由: meeting.confservice.session.change_mode

消息体结构:

{
    "properties": {},
    "body": {
        "etag": 0,
        "updatedTime": 1721307698130,
        "viewState": "SHARE",
        "presenter": "d4f1e2a9-9fea-4f16-882c-e0c7aa341c1c"
    }
}

消息体描述：

字段名	类型	必需	描述	示例值/枚举值
`updatedTime`	long	是	模式变更时间（Unix时间戳，毫秒）	`1721307698130`
`viewState`	string	是	当前会议模式状态	枚举为：`"VIDEO"` `"SHARE"` `"WHITE_BOARD"`
`presenter`	string	否	演示人终端ID（模式为SHARE/WHITE_BOARD时存在）	`"d4f1e2a9-9fea-4f16-882c-e0c7aa341c1c"`

3.2 设备相关的会议通知

namespace: meeting_meeting_v2

endpointId: mh/{deviceId} , deviceId 为获取 token 信息时，返回的 deviceId

3.2.1 预约会议消息

消息路由：meeting.meeting.meeting_device.add

消息体结构：

{
  "properties": {},
  "body": {
    "meetingId": "1721307698130",
    "updatedTime": "1721307698130",
  }
}

3.2.2 更新会议消息

消息路由：meeting.meeting.meeting_device.update

消息体结构：

{
  "properties": {},
  "body": {
    "meetingId": "1721307698130",
    "updatedTime": "1721307698130",
  }
}

附录

Q1: 连接失败如何处理？

检查accessToken有效性

验证endpointId格式是否正确

检查网络连接

Q2: 收不到消息怎么办？

确认订阅的消息路由正确

检查防火墙/代理设置

查看服务端连接状态

视频会议系统实时消息对接文档

MAXHUB视频会议系统实时通知消息接口文档#

1. 文档概述#

2. WebSocket连接规范#

2.1 连接地址#

2.2 连接参数#

2.3 连接示例代码#

3. 消息协议规范#

3.1 会议控制消息#

3.1.1 加入会议通知#

3.1.2 会议模式变更通知#

3.2 设备相关的会议通知#

3.2.1 预约会议消息#

3.2.2 更新会议消息#

附录#

Q1: 连接失败如何处理？#

Q2: 收不到消息怎么办？#