会议事件订阅

会议事件订阅，主要涉及会议相关的事件通知，通过订阅事件，您可以实现接收入会完成通知/解散会议通知/离开会议通知/加入等候室通知/离开等候室通知等功能。

1. 入会完成通知（JoinMeetingCompleted）

事件说明

1）事件解释：创建/加入会议是一个耗时的过程，当用户收到该事件时，代表真正完成了入会操作

2）引入版本： 3.8.10

3）所属模块（method）：Event/Meeting

4）事件名（sub_event）：JoinMeetingCompleted

5）触发条件：用户通过Rooms或CSAPI创建会议/加入会议，都会收到这个事件通知

事件参数

参数名称	参数类型	参数描述
meeting_info	object	会议信息，详见会议信息表
self_user_info	object	用户信息，只在会中返回，详见用户信息表
device_info	object	设备信息
mic_info	object	麦克风信息，详见麦克风信息表
speaker_info	object	扬声器信息，详见扬声器信息表
camera_info	object	摄像头信息，详见摄像头信息表

会议信息表（meeting_info）

参数名称	参数类型	参数描述
meeting_status	int	会议状态： 0：会前 1：会中 2：正在加入会议 3：等候室 4：会前投屏 5：会前pstn电话
meeting_type	int	会议类型，只在会中返回： -1：未知类型 0：一次性会议 1：周期性会议 2：微信会议 4：投屏会议
meeting_title	string	会议标题只在会中返回
meeting_code	string	会议号只在会中返回
meeting_password	string	会议密码只在会中返回
begin_time	int	会议开始时间戳
end_time	int	会议结束时间戳
formatted_meeting_code	string	格式化后会议号只在会中返回
meeting_creator_name	string	会议创建者名字只在会中返回
host_status	int	主持人状态： 0：主持人不在会中 1：主持人在会中

用户信息表（self_user_info）

参数名称	参数类型	参数描述
app_uid	string	账号id
app_id	string	企业id
user_id	string	会中用户id
host	bool	是否是主持人： true：是 false：否
co_host	bool	是否联席主持人： true：是 false：否
instance_id	int	应用类型id
user_type	int	用户类型： 1：普通用户 2：PSTN用户
is_creator	bool	是否会议创建者： true：是 false：否
role_type	int	角色类型：0：未知 1：主持人 2：联席主持人 3：普通用户 4：内部嘉宾 5：外部嘉宾 6：外部嘉宾 7：外部嘉宾 8：同声传译用户
video_on	bool	是否开启视频： true：开启 false：关闭
audio_on	bool	是否开启音频： true：开启 false：关闭
screen_sharing	bool	是否开启屏幕共享： true：开启 false：关闭
screen_share_type	int	屏幕共享类型： 0：屏幕共享 1：白板共享
web_sharing	bool	是否文档共享： true：是 false：否
nickname	string	用户名称

麦克风信息表（mic_info）

参数名称	参数类型	参数描述
switch	bool	是否开启麦克风： true：开启 false：关闭

扬声器信息表（speaker_info）

参数名称	参数类型	参数描述
switch	bool	是否开启麦克风： true：开启 false：关闭
volume	int	扬声器音量

摄像头信息表（camera_info）

参数名称	参数类型	参数描述
switch	bool	是否开启麦克风： true：开启 false：关闭

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Meeting",
    "result": {
        "error_code": 0,
        "message": "",
        "data": {
            "meeting_info": {
                "meeting_status": 0,
                "meeting_type": 0,
                "meeting_title": "",
                "meeting_code": "",
                "meeting_password": "",
                "meeting_time": {
                    "begin_time": 0,
                    "end_time": 0
                },
                "formatted_meeting_code": "",
                "meeting_creator_name": "",
                "host_status": 0
            },
            "self_user_info": {
                "app_uid": "",
                "app_id": "",
                "user_id": "",
                "host": true,
                "co_host": true,
                "instance_id": 0,
                "user_type": 0,
                "is_creator": true,
                "role_type": 0,
                "video_on": true,
                "audio_on": true,
                "screen_sharing": true,
                "screen_share_type": 0,
                "web_sharing": true,
                "nickname": ""
            },
            "device_info": {
                "mic_info": {
                    "switch": true
                },
                "speaker_info": {
                    "switch": true,
                    "volume": 0
                },
                "camera_info": {
                    "switch": true
                }
            }
        }
    },
    "sub_event": "JoinMeetingCompleted"
}

2. 解散会议通知 (DissolveMeeting)

事件说明

1）事件解释：当用户收到该事件时，代表完成了解散会议的操作

2）引入版本： 3.8.10

3）所属模块（method）：Event/Meeting

4）事件名（sub_event）：DissolveMeeting

5）触发条件：用户通过Rooms或CSAPI解散会议，都会收到这个事件通知

事件参数

无事件参数，失败返回错误消息

示例

{
    "jsonrpc": "2.0",
    "method":"Event/Meeting",
    "result":{
        "error_code":0,
        "message":""
    },
    "sub_event": "DissolveMeeting"
}

3. 离开会议通知 (LeaveMeeting)

事件说明

1）事件解释：当用户收到该事件时，代表完成了离开会议的操作

2）引入版本： 3.8.10

3）所属模块（method）：Event/Meeting

4）事件名（sub_event）：LeaveMeeting

5）触发条件：用户通过Rooms或CSAPI离开会议，都会收到这个事件通知

事件参数

参数名称	参数类型	参数描述
leave_reason	int	离会原因： 0：未知原因 1：主动离开 2：被动离开 3：会议被解散 4：其他端入会 >4：其他未定义的原因，后续补充

示例

{
    "jsonrpc": "2.0",
    "method":"Event/Meeting",
    "result":{
        "error_code":0,
        "message":"",
        "data":{
            "leave_reason":1
        }
    },
    "sub_event": "LeaveMeeting"
}

4. 加入等候室通知 (JoinWaitingRoom)

事件说明

1）事件解释：当用户收到该事件时，代表完成了加入等候室的操作

2）引入版本： 3.8.10

3）所属模块（method）：Event/Meeting

4）事件名（sub_event）：JoinWaitingRoom

5）触发条件：用户通过Rooms或CSAPI加入等候室，都会收到这个事件通知

事件参数

参数名称	参数类型	参数描述
meeting_info	object	会议信息，详见会议信息表
device_info	object	设备信息
mic_info	object	麦克风信息，详见麦克风信息表
speaker_info	object	扬声器信息，详见扬声器信息表
camera_info	object	摄像头信息，详见摄像头信息表

会议信息表（meeting_info）

参数名称	参数类型	参数描述
meeting_status	int	会议状态： 0：会前 1：会中 2：正在加入会议 3：等候室 4：会前投屏 5：会前pstn电话
meeting_title	string	会议标题只在会中返回
begin_time	int	会议开始时间戳
end_time	int	会议结束时间戳
formatted_meeting_code	string	格式化后会议号只在会中返回
meeting_creator_name	string	会议创建者名字只在会中返回

麦克风信息表（mic_info）

参数名称	参数类型	参数描述
switch	bool	是否开启麦克风： true：开启 false：关闭

扬声器信息表（speaker_info）

参数名称	参数类型	参数描述
switch	bool	是否开启麦克风： true：开启 false：关闭
volume	int	扬声器音量

摄像头信息表（camera_info）

参数名称	参数类型	参数描述
switch	bool	是否开启麦克风： true：开启 false：关闭

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Meeting",
    "result": {
        "error_code": 0,
        "message": "",
        "data": {
            "meeting_info": {
                "meeting_status": 0,
                "meeting_title": "",
                "meeting_time": {
                    "begin_time": 0,
                    "end_time": 0
                },
                "formatted_meeting_code": "",
                "meeting_creator_name": ""
            },
            "device_info": {
                "mic_info": {
                    "switch": true
                },
                "speaker_info": {
                    "switch": true,
                    "volume": 0
                },
                "camera_info": {
                    "switch": true
                }
            }
        }
    },
    "sub_event": "JoinWaitingRoom"
}

5. 离开等候室通知 (LeaveWaitingRoom)

事件说明

1）事件解释：当用户收到该事件时，代表完成了离开等候室的操作

2）引入版本： 3.8.10

3）所属模块（method）：Event/Meeting

4）事件名（sub_event）：LeaveWaitingRoom

5）触发条件：用户通过Rooms或CSAPI离开等候室，都会收到这个事件通知

事件参数

参数名称	参数类型	参数描述
leave_reason	int	离会原因： 0：未知原因 1：主动离开 2：被动离开 3：会议被解散 4：其他端入会 >4：其他未定义的原因，后续补充

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Meeting",
    "result": {
        "error_code": 0,
        "message": "",
        "data": {
            "leave_reason": 0
        }
    },
    "sub_event": "LeaveWaitingRoom"
}

6. 被移入等候室通知 (MoveToWaitingRoom)

事件说明

1）事件解释：当用户收到该事件时，代表已被主持人移入等候室

2）引入版本： 3.8.10

3）所属模块（method）：Event/Meeting

4）事件名（sub_event）：MoveToWaitingRoom

5）触发条件：用户被主持人移入等候室，都会收到这个事件通知

事件参数

参数名称	参数类型	参数描述
meeting_info	object	会议信息，详见会议信息表
device_info	object	设备信息
mic_info	object	麦克风信息，详见麦克风信息表
speaker_info	object	扬声器信息，详见扬声器信息表
camera_info	object	摄像头信息，详见摄像头信息表

会议信息表（meeting_info）

参数名称	参数类型	参数描述
meeting_status	int	会议状态： 0：会前 1：会中 2：正在加入会议 3：等候室 4：会前投屏 5：会前pstn电话
meeting_title	string	会议标题只在会中返回
begin_time	int	会议开始时间戳
end_time	int	会议结束时间戳
formatted_meeting_code	string	格式化后会议号只在会中返回
meeting_creator_name	string	会议创建者名字只在会中返回

麦克风信息表（mic_info）

参数名称	参数类型	参数描述
switch	bool	是否开启麦克风： true：开启 false：关闭

扬声器信息表（speaker_info）

参数名称	参数类型	参数描述
switch	bool	是否开启麦克风： true：开启 false：关闭
volume	int	扬声器音量

摄像头信息表（camera_info）

参数名称	参数类型	参数描述
switch	bool	是否开启麦克风： true：开启 false：关闭

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Meeting",
    "result": {
        "error_code": 0,
        "message": "",
        "data": {
            "meeting_info": {
                "meeting_status": 0,
                "meeting_title": "",
                "meeting_time": {
                    "begin_time": 0,
                    "end_time": 0
                },
                "formatted_meeting_code": "",
                "meeting_creator_name": "",
                "host_status": 0
            },
            "device_info": {
                "mic_info": {
                    "switch": true
                },
                "speaker_info": {
                    "switch": true,
                    "volume": 0
                },
                "camera_info": {
                    "switch": true
                }
            }
        }
    },
    "sub_event": "MoveToWaitingRoom"
}

7. 更新会议室列表通知 (UpdateMeetingList)

事件说明

1）事件解释：Rooms进入或离开会议时，会更新一遍会议室列表

2）引入版本： 3.8.10

3）所属模块（method）：Event/Meeting

4）事件名（sub_event）：UpdateMeetingList

5）触发条件：用户通过Rooms或CSAPI进入或离开会议时，都会收到这个事件通知

事件参数

参数名称	参数类型	参数描述
meeting_list	array	会议信息列表，目前最多返回10个，详见会议信息表

会议信息表（meeting_list）

参数名称	参数类型	参数描述
meeting_title	string	会议标题只在会中返回
begin_time	int	会议开始时间戳
end_time	int	会议结束时间戳
meeting_creator_name	string	会议创建者名字只在会中返回
meeting_code	string	会议号只在会中返回
meeting_id	string	会议id
meeting_type	int	会议类型，只在会中返回： -1：未知类型 0：一次性会议 1：周期性会议 2：微信会议 4：投屏会议
formatted_meeting_code	string	格式化后会议号只在会中返回

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Meeting",
    "result": {
        "error_code": 0,
        "message": "",
        "data": {
            "meeting_list": [{
                "meeting_title": "XXX的快速会议",
                "meeting_time": {
                    "begin_time": 1686208609,
                    "end_time": 1686208750
                },
                "meeting_creator_name": "xxx",
                "meeting_code": "",
                "meeting_id": "",
                "meeting_type": 1,
                "formatted_meeting_code": ""
            }]
        }
    },
    "sub_event": "UpdateMeetingList"
}

8. 布局切换变更通知 (LayoutSwitchChanged)

事件说明

1）事件解释：当用户收到该事件时，代表完成了布局切换的操作

2）引入版本： 3.9.150

3）所属模块（method）：Event/Meeting

4）事件名（sub_event）：LayoutSwitchChanged

5）触发条件：用户通过Rooms或CSAPI布局切换时，都会收到这个事件通知

事件参数

参数名称	参数类型	参数描述
current_switch_type	int	当前布局切换类型，详见switch_type布局类型
layout_switch_enable	bool	布局是否可见： true：可见 false：不可见
layout_switch_list	array	布局切换列表
switch_type	int	布局类型： 1：宫格布局 2：演讲者布局 3：演讲者布局 4：右侧成员列表布局 5：上L型布局 6：下L型布局 7：回型布局
enable	bool	是否可以切换： true：可用 false：不可以
show_voice_active	bool	是否显示语音激励小窗，只有演讲者布局下才有效： true：显示 false：不显示

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Meeting",
    "result": {
        "error_code": 0,
        "message": "成功",
        "data": {
            "current_switch_type": 2,
            "layout_switch_enable": true,
            "layout_switch_list": [{
                    "switch_type": 1,
                    "enable": true
                },
                {
                    "switch_type": 2,
                    "enable": true,
                    "show_voice_active": true
                },
                {
                    "switch_type": 3,
                    "enable": true
                },
                {
                    "switch_type": 4,
                    "enable": true
                }, {
                    "switch_type": 5,
                    "enable": true
                }, {
                    "switch_type": 6,
                    "enable": true
                }, {
                    "switch_type": 7,
                    "enable": true
                }
            ]
        }
    },
    "sub_event": "LayoutSwitchChanged"
}

下载会议事件订阅.pdf

文章内容是否对您有帮助？

有帮助

无帮助

能否告知我们这篇文章的问题？（选填）

操作步骤描述不清晰/看不懂这个功能不好用找不到描述的入口没找到我想要了解的信息

0 / 150