会议控制(MeetingControl)API接口

会议控制API,主要涉及会中控制,通过API,您可以实现开启会中录制/变更主持人/移除参会者/打开聊天窗口/获取会议控制信息 等功能。

1. 查询窗口信息 (Query MeetingControl)

1.1 查询窗口信息 (Query MeetingControl)

1.2 查询会议控制所有信息

接口说明

1)接口解释:用于查询会议控制模块的相关信息

2)引入版本: 3.8.10

3)调用方式(method):Query

4)调用结果:同步返回调用结果

输入参数(params)

参数名称

是否必选

参数类型

参数描述

path

array

模块名

输出参数(data)

参数名称

参数类型

参数描述

is_caption_open

bool

是否开启字幕:
true:开启
false:关闭

is_caption_support

bool

是否支持字幕:
true:支持
false:不支持

current_font_size

int

当前字幕字体大小

source_lang_settings_list

array

源语言设置,详见源语言设置列表

translate_lang_settings_list

array

翻译语言设置,详见翻译语言设置列表

multi_screen_caption_settings

array

多屏字幕设置,详见多屏字幕设置列表

two_lang_show_settings

array

双语显示设置,详见双语显示设置列表

support_size_arr

array

字幕支持大小,详见字幕支持大小列表

meeting_info

object

会中控制的选项信息,详见会议信息表

源语言设置列表(source_lang_settings_list)

参数名称

参数类型

参数描述

is_selected

bool

是否打开开关:
true:是
false:否

key

string

设置项索引名称

description

string

描述

enable

bool

是否展示:
true:是
false:否

翻译语言设置列表(translate_lang_settings_list)

详见上方源语言设置列表

多屏字幕设置列表(multi_screen_caption_settings)

详见上方源语言设置列表

双语显示设置列表(two_lang_show_settings)

详见上方源语言设置列表

字幕支持大小列表(support_size_arr)

参数名称

参数类型

参数描述

font_size

int

字体大小

description

string

描述

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Query",
    "params": {
        "path": ["MeetingControl"]
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Query",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "message": "成功",
        "data": {
            "caption_info": {
                "is_caption_open": false,
                "source_lang_settings_list": [{
                    "is_selected": true,
                    "key": "mx",
                    "description": "自动识别",
                    "enable": true
                }, {
                    "is_selected": false,
                    "key": "zh",
                    "description": "说中文",
                    "enable": true
                }, {
                    "is_selected": false,
                    "key": "en",
                    "description": "说英文",
                    "enable": true
                }, {
                    "is_selected": false,
                    "key": "ja",
                    "description": "说日语",
                    "enable": true
                }],
                "support_size_arr": [{
                    "font_size": 20,
                    "description": "小"
                }, {
                    "font_size": 24,
                    "description": "中"
                }, {
                    "font_size": 28,
                    "description": "大"
                }, {
                    "font_size": 32,
                    "description": "特大"
                }],
                "current_font_size": 24,
                "is_caption_support": true,
                "translate_lang_settings_list": [{
                    "is_selected": false,
                    "key": "NO_TRANSLATE",
                    "description": "不翻译",
                    "enable": true
                }, {
                    "is_selected": false,
                    "key": "zh",
                    "description": "中文",
                    "enable": true
                }, {
                    "is_selected": true,
                    "key": "en",
                    "description": "英文",
                    "enable": true
                }],
                "multi_screen_caption_settings": {
                    "is_selected": true,
                    "key": "MULTI_SCREEN_CAPTION",
                    "description": "多屏同时显示字幕",
                    "enable": false
                },
                "two_lang_show_settings": {
                    "is_selected": false,
                    "key": "ALL_SHOW",
                    "description": "同时显示双语",
                    "enable": true
                }
            },
            "meeting_info": {
                "is_mute_when_join_meeting": false,
                "is_allow_unmute_by_self": false,
                "is_enable_waiting_room": false,
                "is_notify_when_join_meeting": false,
                "is_internal_user_only": false
            }
        }
    }
}

1.3 查询会议控制部分信息

接口说明

1)接口解释:用于查询会议控制模块的相关信息

2)引入版本: 3.28.290

3)调用方式(method):Query

4)调用结果:同步返回调用结果

输入参数(path)

详见1.2查询会议控制所有信息

输出参数(data)

详见1.2查询会议控制所有信息

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Query",
    "params": {
        "path": ["MeetingControl", "MeetingInfo"] // 查询MeetingControl模块下的MeetingInfo节点
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Query",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "message": "成功",
        "data": {
            "is_mute_when_join_meeting": false,
            "is_enable_waiting_room": false,
            "is_allow_unmute_by_self": false,
            "is_notify_when_join_meeting": false,
            "is_internal_user_only": false
        }
    }
}

2. 请求录制 (RequestRecord)

接口说明

1)接口解释:用于会中请求录制

2)引入版本: 3.9.150

3)调用方式(method):Call/MeetingControl

4)调用名(action):RequestRecord

5)调用结果:异步返回调用结果,RequestRecord,需要订阅 MeetingControl 事件,详见 4. 请求录制通知 (RequestRecord)

6)前置依赖:
a. Rooms用户需要在会中
b. Rooms用户不能处于正在录制状态
c. Rooms用户需要是主持人/联席主持人(如果Rooms用户不是主持人/联席主持人,则会向主持人发起请求录制的窗口)

输入参数(action_params)

无输入参数

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "GI9MDDQX83768QN",
    "method": "Call/MeetingControl", 
    "params": {
        "action": "RequestRecord"
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "GI9MDDQX83768QN",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "RequestRecord",
        "message": ""
    }
}

3. 启动录制 (StartRecord)

接口说明

1)接口解释:用于会中启动录制

2)引入版本: 3.9.150

3)调用方式(method):Call/MeetingControl

4)调用名(action):StartRecord

5)前置依赖:
a. Rooms用户需要在会中
b. Rooms用户不能处于正在录制状态

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

mobile_address

string

邮箱地址

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "params": {
        "action": "StartRecord",
        "action_params": {
            "mobile_address": "xxx@xxx.com"
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "GI9MDDQX83768QN",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "StartRecord",
        "message": ""
    }
}

4. 静音所有成员 (MuteAll)

接口说明

1)接口解释:用于会中静音所有成员

2)引入版本: 3.9.150

3)调用方式(method):Call/MeetingControl

4)调用名(action):MuteAll

5)调用结果:异步返回调用结果,MuteAll,需要订阅 MeetingControl 事件,详见 2. 静音所有成员通知 (MuteAll)

6)前置依赖:
a. Rooms用户需要在会中

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

audio_allow_unmute_by_self

bool

是否允许自我解除静音:
true:是
false:否

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "params": {
        "action": "MuteAll",
        "action_params": {
            "audio_allow_unmute_by_self": false
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "MuteAll",
        "message": ""
    }
}

5. 参会者id列表 (ListMemberIds)

接口说明

1)接口解释:用于获取参会成员的user_id列表

2)引入版本: 3.9.150

3)调用方式(method):Call/MeetingControl

4)调用名(action):ListMemberIds

5)前置依赖:
a. Rooms用户需要在会中

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

begin_count

int

开始位置,0表示第一个人

type

int

获取类型:
0:等候室成员
1:可见的参会者

end_count

int

结束位置,1表示第二个人

输出参数(data)

参数名称

参数类型

参数描述

data

array

参会者user_id数组

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "params": {
        "action": "ListMemberIds",
        "action_params": {
            "begin_count": 0,
            "type": 1, 
            "end_count": 1
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "ListMemberIds",
        "message": "",
        "data": ["144115352466200111"]
    }
}

6. 变更主持人 (ChangeHost)

接口说明

1)接口解释:用于会中变更主持人

2)引入版本: 3.9.150

3)调用方式(method):Call/MeetingControl

4)调用名(action):ChangeHost

5)调用结果:异步返回调用结果,HostChanged,需要订阅 Members 事件,详见 2. 主持人变更通知 (HostChanged)

6)前置依赖:
a. Rooms用户需要在会中
b. Rooms用户需要是主持人/联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

user_id

string

用户user_id,可通过 5. 参会者id列表 (ListMemberIds) 获取

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "WKTTP1E4R47JW4J",
    "method": "Call/MeetingControl",
    "params": {
        "action": "ChangeHost",
        "action_params": {
            "user_id": "xxx" 
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "WKTTP1E4R47JW4J",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "ChangeHost",
        "message": ""
    }
}

7. 静音参会成员 (MuteMember)

接口说明

1)接口解释:用于会中静音指定参会成员

2)引入版本: 3.9.150

3)调用方式(method):Call/MeetingControl

4)调用名(action):MuteMember

5)前置依赖:
a. Rooms用户需要在会中
b. Rooms用户需要是主持人/联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

user_id

string

用户user_id,可通过 5. 参会者id列表 (ListMemberIds) 获取

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "params": {
        "action": "MuteMember",
        "action_params": {
            "user_id": "xxx",
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "MuteMember",
        "message": ""
    }
}

8. 关闭参会者视频 (StopVideo)

接口说明

1)接口解释:用于会中关闭指定参会者视频

2)引入版本: 3.9.150

3)调用方式(method):Call/MeetingControl

4)调用名(action):StopVideo

5)前置依赖:
a. Rooms用户需要在会中
b. Rooms用户需要是主持人/联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

user_id

string

用户user_id,可通过 5. 参会者id列表 (ListMemberIds) 获取

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "params": {
        "action": "StopVideo",
        "action_params": {
            "user_id": "xxx"
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "StopVideo",
        "message": ""
    }
}

9. 移除参会者 (RemoveMember)

接口说明

1)接口解释:用于会中移除指定参会成员

2)引入版本: 3.9.150

3)调用方式(method):Call/MeetingControl

4)调用名(action):RemoveMember

5)调用结果:异步返回调用结果,UserRemove,需要订阅 MeetingControl 事件,详见 5. 移除会中成员通知 (UserRemove)

6)前置依赖:
a. Rooms用户需要在会中
b. Rooms用户需要是主持人/联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

user_id

string

用户user_id,可通过 5. 参会者id列表 (ListMemberIds) 获取

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "params": {
        "action": "MuteMember",
        "action_params": {
            "user_id": "xxx"
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "MuteMember",
        "message": ""
    }
}

10. 焦点视频 (SpotLight)

接口说明

1)接口解释:用于会中设置焦点视频开启或关闭

2)引入版本: 3.9.150

3)调用方式(method):Call/MeetingControl

4)调用名(action):SpotLight

5)调用结果:异步返回调用结果,SpotLight,需要订阅 MeetingControl 事件,详见 1. 焦点视频状态变更通知 (SpotLight)

6)前置依赖:
a. Rooms用户需要在会中
b. Rooms用户需要是主持人/联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

user_id

string

用户user_id,可通过 5. 参会者id列表 (ListMemberIds) 获取

switch

bool

是否开启焦点视频:
true:开启
false:关闭

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "params": {
        "action": "SpotLight",
        "action_params": {
            "user_id": "xxx",
            "switch": false
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "SpotLight",
        "message": ""
    }
}

11. 等候室准入成员 (AdmitMemberToMeeting)

接口说明

1)接口解释:用于准入指定成员从等候室进入会议

2)引入版本: 3.9.150

3)调用方式(method):Call/MeetingControl

4)调用名(action):AdmitMemberToMeeting

5)前置依赖:
a. Rooms用户需要在会中
b. Rooms用户需要是主持人/联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

user_id

string

用户user_id,可通过 5. 参会者id列表 (ListMemberIds) 获取

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "params": {
        "action": "AdmitMemberToMeeting",
        "action_params": {
            "user_id": "xxx"
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "GI9MDDQX83768QN",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "AdmitMemberToMeeting",
        "message": ""
    }
}

12. 结束录制 (StopRecording)

接口说明

1)接口解释:用于会中结束录制

2)引入版本: 3.13.190

3)调用方式(method):Call/MeetingControl

4)调用名(action):StopRecording

5)前置依赖:
a. Rooms用户需要在会中
b. Rooms用户需要是主持人/联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

user_id

string

用户user_id,可通过 5. 参会者id列表 (ListMemberIds) 获取

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "params": {
        "action": "StopRecording",
        "action_params": {
            "user_id": "xxx"
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "StopRecording",
        "message": ""
    }
}

13. 锁定会议 (LockMeeting)

接口说明

1)接口解释:用于锁定会议,锁定会议后新成员将无法加入

2)引入版本: 3.13.190

3)调用方式(method):Call/MeetingControl

4)调用名(action):LockMeeting

5)前置依赖:
a. Rooms用户需要在会中
b. Rooms用户需要是主持人/联席主持人

输入参数(action_params)

无输入参数

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "QSIZ35ZWYL238WI",
    "method": "Call/MeetingControl", 
    "params": {
        "action": "LockMeeting"
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "QSIZ35ZWYL238WI",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "LockMeeting",
        "message": ""
    }
}

14. 将成员移入等候室 (MoveToWaitingRoom)

接口说明

1)接口解释:用于会中将成员移入等候室

2)引入版本: 3.13.190

3)调用方式(method):Call/MeetingControl

4)调用名(action):MoveToWaitingRoom

5)调用结果:异步返回调用结果,UserRemove,需要订阅 MeetingControl 事件,详见 5. 移除会中成员通知 (UserRemove)

6)前置依赖:
a. Rooms用户需要在会中
b. Rooms用户需要是主持人/联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

user_id

string

用户user_id,可通过 5. 参会者id列表 (ListMemberIds) 获取

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "params": {
        "action": "MoveToWaitingRoom",
        "action_params": {
            "user_id": "xxx"
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "3FSWYMVSZRUXJXF",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "MoveToWaitingRoom",
        "message": ""
    }
}

15. 打开聊天窗口 (OpenChatWindow)

接口说明

1)接口解释:用于会中打开聊天窗口

2)引入版本: 3.13.190

3)调用方式(method):Call/MeetingControl

4)调用名(action):OpenChatWindow

5)前置依赖:
a. Rooms需要在会中

输入参数(action_params)

无输入参数

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "VKQNBWUGHVLEZT4",
    "method": "Call/MeetingControl", 
    "params": {
        "action": "OpenChatWindow"
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "VKQNBWUGHVLEZT4",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "OpenChatWindow",
        "message": ""
    }
}

16. 关闭聊天窗口 (CloseChatWindow)

接口说明

1)接口解释:用于会中关闭聊天窗口

2)引入版本: 3.13.190

3)调用方式(method):Call/MeetingControl

4)调用名(action):CloseChatWindow

5)前置依赖:
a. Rooms需要在会中

输入参数(action_params)

无输入参数

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "VKQNBWUGHVLEZT4",
    "method": "Call/MeetingControl", 
    "params": {
        "action": "CloseChatWindow"
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "VKQNBWUGHVLEZT4",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "CloseChatWindow",
        "message": ""
    }
}

17. 打开字幕 (OpenCaption)

接口说明

1)接口解释:用于会中打开字幕

2)引入版本: 3.13.190

3)调用方式(method):Call/MeetingControl

4)调用名(action):OpenCaption

5)前置依赖:
a. Rooms需要在会中

输入参数(action_params)

无输入参数

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "VKQNBWUGHVLEZT4",
    "method": "Call/MeetingControl", 
    "params": {
        "action": "OpenCaption"
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "VKQNBWUGHVLEZT4",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "OpenCaption",
        "message": ""
    }
}

18. 关闭字幕 (CloseCaption)

接口说明

1)接口解释:用于会中关闭字幕

2)引入版本: 3.13.190

3)调用方式(method):Call/MeetingControl

4)调用名(action):CloseCaption

5)前置依赖:
a. Rooms需要在会中

输入参数(action_params)

无输入参数

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "VKQNBWUGHVLEZT4",
    "method": "Call/MeetingControl", 
    "params": {
        "action": "CloseCaption"
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "VKQNBWUGHVLEZT4",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "CloseCaption",
        "message": ""
    }
}

19. 设置字幕参数 (SetCaptionParams)

接口说明

1)接口解释:用于会中设置字幕参数

2)引入版本: 3.13.190

3)调用方式(method):Call/MeetingControl

4)调用名(action):SetCaptionParams

5)前置依赖:
a. Rooms需要在会中

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

current_font_size

int

字号:
0:小
1:中
2:大
3:特大

source_language

int

语言模式:
0:自动识别
1:中文
2:英文

translate_language

int

翻译开关:
0:不翻译
1:中文
2:英文

two_language_is_check

bool

是否同时显示双语:
true:是
false:否

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "M1FHYI38ODUG6IU",
    "method": "Call/MeetingControl", 
    "params": {
        "action": "SetCaptionParams",
           "action_params": {
            "current_font_size": 0,
            "source_language": 0,
            "translate_language": 0 ,
            "two_language_is_check": true
         } 
    }
}

response

{
    "jsonrpc": "2.0",
    "id": "M1FHYI38ODUG6IU",
    "method": "Call/MeetingControl",
    "result": {
        "error_code": 0,
        "action": "SetCaptionParams",
        "message": ""
    }
}

20. 设置联席主持人 (SetCoHost)

接口说明

1)接口解释:用于会中设置联席主持人

2)引入版本: 3.28.290

3)调用方式(method):Call/MeetingControl

4)调用名(action):SetCoHost

5)前置依赖:
a. Rooms需要在会中
b. Rooms需要是主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

user_id

string

用户user_id,可通过 5. 参会者id列表 (ListMemberIds) 获取

is_set_cohost

bool

设置/回收联席主持人
true:设置为联席主持人
false:回收联席主持人权限

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/MeetingControl",
    "params": {
        "action": "SetCoHost",
        "action_params": {
            "user_id": "xxx",
            "is_set_cohost": false
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Call/MeetingControl",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "action": "SetCoHost",
        "message": ""
    }
}

21. 回收主持人 (ReClaimHost)

接口说明

1)接口解释:用于会中回收主持人权限

2)引入版本: 3.28.290

3)调用方式(method):Call/MeetingControl

4)调用名(action):ReClaimHost

5)前置依赖:
a. Rooms需要在会中
b. Rooms需要是会议的创建者

输入参数(action_params)

无输入参数

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/MeetingControl",
    "params": {
        "action": "ReClaimHost"
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Call/MeetingControl",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "action": "ReClaimHost",
        "message": ""
    }
}

22. 解除所有成员静音 (UnMuteAll)

接口说明

1)接口解释:用于会中解除所有成员的静音

2)引入版本: 3.28.290

3)调用方式(method):Call/MeetingControl

4)调用名(action):UnMuteAll

5)前置依赖:
a. Rooms需要在会中
b. Rooms需要是主持人或联席主持人

输入参数(action_params)

无输入参数

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/MeetingControl",
    "params": {
        "action": "UnMuteAll"
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Call/MeetingControl",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "action": "UnMuteAll",
        "message": ""
    }
}

23. 解除成员静音 (UnMuteMember)

接口说明

1)接口解释:用于会中解除单个成员的静音

2)引入版本: 3.28.290

3)调用方式(method):Call/MeetingControl

4)调用名(action):UnMuteMember

5)前置依赖:
a. Rooms需要在会中
b. Rooms需要是主持人或联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

user_id

string

用户user_id,可通过 5. 参会者id列表 (ListMemberIds) 获取

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/MeetingControl",
    "params": {
        "action": "UnMuteMember",
        "action_params": {
            "user_id": "xxx"
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Call/MeetingControl",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "action": "UnMuteMember",
        "message": ""
    }
}

24. 成员入会时静音 (MuteWhenJoinMeeting)

接口说明

1)接口解释:用于设置成员入会时是否静音

2)引入版本: 3.28.290

3)调用方式(method):Call/MeetingControl

4)调用名(action):MuteWhenJoinMeeting

5)前置依赖:
a. Rooms需要在会中
b. Rooms需要是主持人或联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

enable

bool

成员入会时是否静音开关
true:开
false:关

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/MeetingControl",
    "params": {
        "action": "MuteWhenJoinMeeting",
        "action_params": {
            "enable": false
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Call/MeetingControl",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "action": "MuteWhenJoinMeeting",
        "message": ""
    }
}

25. 允许成员自我解除静音 (AllowUnmuteBySelf)

接口说明

1)接口解释:用于设置允许成员自我解除静音

2)引入版本: 3.28.290

3)调用方式(method):Call/MeetingControl

4)调用名(action):AllowUnmuteBySelf

5)前置依赖:
a. Rooms需要在会中
b. Rooms需要是主持人或联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

enable

bool

允许成员自我解除静音开关
true:开
false:关

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/MeetingControl",
    "params": {
        "action": "AllowUnmuteBySelf",
        "action_params": {
            "enable": false
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Call/MeetingControl",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "action": "AllowUnmuteBySelf",
        "message": ""
    }
}

26. 成员进入时播放提示音 (NotifyWhenJoinMeeting)

接口说明

1)接口解释:用于设置成员进入时播放提示音

2)引入版本: 3.28.290

3)调用方式(method):Call/MeetingControl

4)调用名(action):NotifyWhenJoinMeeting

5)前置依赖:
a. Rooms需要在会中
b. Rooms需要是主持人或联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

enable

bool

成员进入时播放提示音开关
true:开
false:关

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/MeetingControl",
    "params": {
        "action": "NotifyWhenJoinMeeting",
        "action_params": {
            "enable": false
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Call/MeetingControl",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "action": "NotifyWhenJoinMeeting",
        "message": ""
    }
}

27. 开启等候室 (EnableWaitingRoom)

接口说明

1)接口解释:用于设置等候室的开启和关闭

2)引入版本: 3.28.290

3)调用方式(method):Call/MeetingControl

4)调用名(action):EnableWaitingRoom

5)前置依赖:
a. Rooms需要在会中
b. Rooms需要是主持人或联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

enable

bool

等候室开关
true:开
false:关

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/MeetingControl",
    "params": {
        "action": "EnableWaitingRoom",
        "action_params": {
            "enable": false
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Call/MeetingControl",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "action": "EnableWaitingRoom",
        "message": ""
    }
}

28. 开启等候室 (EnableWaitingRoom)

接口说明

1)接口解释:用于设置仅企业内部成员可入会

2)引入版本: 3.28.290

3)调用方式(method):Call/MeetingControl

4)调用名(action):EnableAttendeeRestriction

5)前置依赖:
a. Rooms需要在会中
b. Rooms需要是主持人或联席主持人

输入参数(action_params)

参数名称

是否必选

参数类型

参数描述

type

int

类型
0:任何成员可入会
1:仅企业内部成员可入会

输出参数(data)

成功返回空消息,失败返回错误信息,错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/MeetingControl",
    "params": {
        "action": "EnableAttendeeRestriction",
        "action_params": {
            "type": 0
        }
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Call/MeetingControl",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "action": "EnableAttendeeRestriction",
        "message": ""
    }
}
下载 会议控制(MeetingControl).pdf
文章内容是否对您有帮助?
有帮助
无帮助