会议(Meeting)API接口
会议API,主要涉及会议相关的控制,通过API,您可以实现创建/加入/离开/解散会议/获取会议信息 等功能。
1. 查询会议信息 (Query Meeting)
1.1 查询会议所有信息
接口说明
1)接口解释:用于查询会议模块的相关信息
2)引入版本: 3.8.10
3)调用方式(method):Query
4)调用结果:同步返回调用结果
输入参数(params)
参数名称 | 是否必选 | 参数类型 | 参数描述 |
---|---|---|---|
path | 是 | array | 模块名 |
输出参数(data)
参数名称 | 参数类型 | 参数描述 |
---|---|---|
multi_scree_info | object | 多屏信息,详见多屏信息表 |
layout_info | object | 布局信息,只在会中返回 |
main_screen_layout_info | object | 主屏信息,只在会中返回,详见主屏信息表 |
secondary_screen_layout_info | object | 副屏信息对象,只在双屏下返回,详见副屏信息表 |
layout_switch_info | object | 布局切换信息,只在会中返回,详见布局切换信息表 |
meeting_info | object | 会议信息,详见会议信息表 |
self_info | object | 用户信息,只在会中返回,详见用户信息表 |
share_user_info | object | 共享用户信息,详见共享用户信息表 |
多屏信息表(multi_scree_info)
参数名称 | 参数类型 | 参数描述 |
---|---|---|
multi_screen_status | int | 多屏状态: |
main_monitor_id | string | 主屏幕唯一标识 只在双屏下返回 |
主屏信息表(main_screen_layout_info)
参数名称 | 参数类型 | 参数描述 |
---|---|---|
layout_model | int | 布局模式 只在layout_type=主持人模式下有效 决定大画面的显示内容: |
show_small_view | bool | 是否显示缩略图小画面 只在layout_type=主持人模式下有效: |
layout_type | int | 布局类型: |
副屏信息表(secondary_screen_layout_info)
注:详见主屏信息表(main_screen_layout_info)
布局切换信息表(layout_switch_info)
参数名称 | 参数类型 | 参数描述 |
---|---|---|
current_switch_type | int | 当前布局切换类型,详见switch_type布局类型 |
layout_switch_enable | bool | 布局是否可见: |
layout_switch_list | array | 布局切换列表 |
switch_type | int | 布局切换类型: |
enable | bool | 是否可以切换: |
show_voice_active | bool | 是否显示语音激励小窗,只有演讲者布局下才有效: |
会议信息表(meeting_info)
参数名称 | 参数类型 | 参数描述 |
---|---|---|
meeting_status | int | 会议状态: |
meeting_type | int | 会议类型,只在会中返回: |
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 | 主持人状态: |
meeting_url | string | 会议链接 只在会中返回 |
用户信息表(self_info)
参数名称 | 参数类型 | 参数描述 |
---|---|---|
app_uid | string | 账号id |
app_id | string | 企业id |
user_id | string | 会中用户id |
host | bool | 是否是主持人: |
co_host | bool | 是否联席主持人: |
instance_id | int | 应用类型id |
user_type | int | 用户类型: |
is_creator | bool | 是否会议创建者: |
role_type | int | 角色类型:0:未知 |
video_on | bool | 是否开启视频: |
audio_on | bool | 是否开启音频: |
screen_sharing | bool | 是否开启屏幕共享: |
screen_share_type | int | 屏幕共享类型: |
web_sharing | bool | 是否文档共享: |
nickname | string | 用户名称 |
共享用户信息表(share_user_info)
参数名称 | 参数类型 | 参数描述 |
---|---|---|
meeting_list | array | 会议信息数组,目前最多返回 10 个 |
meeting_id | string | 会议id |
请求示例
request
{
"jsonrpc": "2.0",
"id": "xxx",
"method": "Query",
"params": {
"path": ["Meeting"]
}
}
response
{
"jsonrpc": "2.0",
"id": "xxx",
"result": {
"error_code": 0,
"message": "",
"data": {
"meeting": {
"multi_scree_info": {
"multi_screen_status": 0,
"main_monitor_id": ""
},
"layout_info": {
"main_screen_layout_info": {
"layout_model": 0,
"show_small_view": true,
"layout_type": 0
},
"secondary_screen_layout_info": {
"layout_model": 0,
"show_small_view": true,
"layout_type": 0
},
"layout_switch_info": {
"current_switch_type": 1,
"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
}
]
}
},
"meeting_info": {
"meeting_status": 0,
"meeting_type": 0,
"meeting_title": "",
"meeting_code": "",
"meeting_password": "",
"meeting_time": {
"begin_time": 1686207304,
"end_time": 1686207502
},
"formatted_meeting_code": "",
"meeting_creator_name": "",
"host_status": 0,
"meeting_url": ""
},
"self_info": {
"share_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": ""
}
},
"meeting_list": [{
"meeting_title": "XXX的快速会议",
"meeting_time": {
"begin_time": 1686207304,
"end_time": 1686207502
},
"meeting_creator_name": "xxx",
"meeting_code": "",
"meeting_id": "",
"meeting_type": 1,
"formatted_meeting_code": ""
}]
}
}
}
}
1.2 查询会议部分信息
接口说明
1)接口解释:用于查询会议模块的相关信息
2)引入版本: 3.8.10
3)调用方式(method):Query
4)调用结果:同步返回调用结果
输入参数(path)
详见 1.1 查询会议所有信息
输出参数(data)
详见 1.1 查询会议所有信息
请求示例
request
{
"jsonrpc": "2.0",
"id": "xxx",
"method": "Query",
"params": {
"path": ["Meeting","MeetingInfo","MeetingCode"] // 请求meeting_info下的meeting_code(会议号,只在会中返回)
}
}
response
{
"jsonrpc": "2.0",
"method": "Query",
"id": "xxx",
"result": {
"error_code": 0,
"message": "成功",
"data": {
"meeting_code": "xxx"
}
}
}
2. 快速会议 (StartMeeting)
接口说明
1)接口解释:用于创建一次性会议或个人专属会议
2)引入版本: 3.8.10
3)调用方式(method):Call/Meeting
4)调用名(action):StartMeeting
5)调用结果:异步返回调用结果,JoinMeetingCompleted,需要订阅 Meeting 事件,详见 1. 入会完成通知 (JoinMeetingCompleted)
6)前置依赖:
a.Rooms用户需要有快速会议的能力
b.Rooms用户不处于会中
输入参数(action_params)
参数名称 | 是否必选 | 参数类型 | 参数描述 |
---|---|---|---|
meeting_type | 是 | string | 会议类型: |
输出参数(data)
注:成功返回空消息,失败返回错误信息,错误码详见 错误码定义
请求示例
request
{
"jsonrpc": "2.0",
"id": "xxx",
"method": "Call/Meeting",
"params":{
"action": "StartMeeting",
"action_params": {
"meeting_type": "instant"
}
}
}
response
{
"jsonrpc": "2.0",
"id":"xxx",
"method":"Call/Meeting",
"result":{
"error_code":0,
"message":"",
"action":"StartMeeting"
}
}
3. 加入会议 (JoinMeeting)
接口说明
1)接口解释:用于加入已创建完成的会议
2)引入版本: 3.8.10
3)调用方式(method):Call/Meeting
4)调用名(action):JoinMeeting
5)调用结果:异步返回调用结果,JoinMeetingCompleted,需要订阅 Meeting 事件,详见 1. 入会完成通知 (JoinMeetingCompleted)
6)前置依赖:
a.Rooms用户需要有会议的能力
b.Rooms用户不处于会中
输入参数(action_params)
参数名称 | 是否必选 | 参数类型 | 参数描述 |
---|---|---|---|
meeting_code | 是 | string | 会议码 |
password | 是 | string | 入会密码,没有入会密码时输入空参数 |
mic_enable | 是 | bool | 是否开启麦克风: |
camera_enable | 是 | bool | 是否开启摄像头: |
输出参数(data)
注:成功返回空消息,失败返回错误信息,错误码详见 错误码定义
请求示例
request
{
"jsonrpc": "2.0",
"id": "xxx",
"method": "Call/Meeting",
"params": {
"action": "JoinMeeting",
"action_params": {
"meeting_code": "",
"password": "",
"mic_enable": true,
"camera_enable": true
}
}
}
response
{
"jsonrpc": "2.0",
"id":"xxx",
"method":"Call/Meeting",
"result":{
"error_code":0,
"message":"",
"action":"JoinMeeting"
}
}
4. 解散会议 (DissolveMeeting)
接口说明
1)接口解释:用于解散当前所在的会议
2)引入版本: 3.8.10
3)调用方式(method):Call/Meeting
4)调用名(action):DissolveMeeting
5)调用结果:异步返回调用结果,DissolveMeeting,需要订阅 Meeting 事件,详见 2. 解散会议通知 (DissolveMeeting)
6)前置依赖:
a.Rooms用户需要在会中
b.Rooms用户在会中需要是会议的主持人/联席主持人
输入参数(action_params)
注:无输入参数
输出参数(data)
注:成功返回空消息,失败返回错误信息,错误码详见 错误码定义
请求示例
request
{
"jsonrpc": "2.0",
"id": "xxx",
"method": "Call/Meeting",
"params":{
"action": "DissolveMeeting"
}
}
response
{
"jsonrpc": "2.0",
"id":"xxx",
"method":"Call/Meeting",
"result":{
"error_code":0,
"message":"",
"action":"DissolveMeeting"
}
}
5. 离开会议 (LeaveMeeting)
接口说明
1)接口解释:用于离开当前所在的会议
2)引入版本: 3.8.10
3)调用方式(method):Call/Meeting
4)调用名(action):LeaveMeeting
5)调用结果:异步返回调用结果,LeaveMeeting,需要订阅 Meeting 事件,详见 3. 离开会议通知 (LeaveMeeting)
6)前置依赖:
a.Rooms用户需要在会中
输入参数(action_params)
注:无输入参数
输出参数(data)
注:成功返回空消息,失败返回错误信息,错误码详见 错误码定义
请求示例
request
{
"jsonrpc": "2.0",
"id": "xxx",
"method": "Call/Meeting",
"params":{
"action": "LeaveMeeting"
}
}
response
{
"jsonrpc": "2.0",
"id":"xxx",
"method":"Call/Meeting",
"result":{
"error_code":0,
"message":"",
"action":"LeaveMeeting"
}
}
6. 离开等候室 (LeaveWaitingRoom)
接口说明
1)接口解释:主持人未允许你进入会议或当前会议已预订但未开始时则会进入等候室,此接口用于离开当前的等候室
2)引入版本: 3.8.10
3)调用方式(method):Call/Meeting
4)调用名(action):LeaveWaitingRoom
5)调用结果:异步返回调用结果,LeaveWaitingRoom,需要订阅 Meeting 事件,详见 5. 离开等候室通知 (LeaveWaitingRoom)
6)前置依赖:
a.Rooms用户加入会议并在等候室中
输入参数(action_params)
注:无输入参数
输出参数(data)
注:成功返回空消息,失败返回错误信息,错误码详见 错误码定义
请求示例
request
{
"jsonrpc": "2.0",
"id": "xxx",
"method": "Call/Meeting",
"params":{
"action": "LeaveWaitingRoom"
}
}
response
{
"jsonrpc": "2.0",
"id":"xxx",
"method":"Call/Meeting",
"result":{
"error_code":0,
"message":"",
"action":"LeaveWaitingRoom"
}
}
7. 切换布局 (SwitchLayout)
接口说明
1)接口解释:用于切换会议中的布局显示
2)引入版本: 3.9.150
3)调用方式(method):Call/Meeting
4)调用名(action):LayoutSwitchChanged
5)调用结果:异步返回调用结果,LayoutSwitchChanged,需要订阅 Meeting 事件,详见 8. 布局切换变更通知 (LayoutSwitchChanged)
6)前置依赖:
a.Rooms需要在会中且是2人及以上的会议
输入参数(action_params)
参数名称 | 是否必选 | 参数类型 | 参数描述 |
---|---|---|---|
switch_type | 是 | int | 布局类型: |
show_voice_active | 是 | bool | 是否显示语音激励小窗,切换演讲者布局时有效 ( 注意:首次切换到演讲者布局时,会强制显示小窗,该参数无效): |
输出参数(data)
注:成功返回空消息,失败返回错误信息,错误码详见 错误码定义
请求示例
request
{
"jsonrpc":"2.0",
"id":"xxx",
"method":"Call/Meeting",
"params":{
"action":"SwitchLayout",
"action_params":{
"switch_type":1,
"show_voice_active":true
}
}
}
response
{
"jsonrpc":"2.0",
"method":"Call/Meeting",
"id":"xxx",
"result":{
"error_code":0,
"action":"SwitchLayout",
"message":""
}
}