会议控制(MeetingControl)API接口
会议控制API,主要涉及会中控制,通过API,您可以实现开启会中录制/变更主持人/移除参会者/打开聊天窗口/获取会议控制信息 等功能。
1. 请求录制 (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": ""
}
}
2. 启动录制 (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": ""
}
}
3. 静音所有成员 (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 | 是否允许自我解除静音: |
输出参数(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": ""
}
}
4. 参会者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 | 获取类型: |
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"]
}
}
5. 变更主持人 (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,可通过 4. 参会者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": ""
}
}
6. 静音参会成员 (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,可通过 4. 参会者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": ""
}
}
7. 关闭参会者视频 (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,可通过 4. 参会者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": ""
}
}
8. 移除参会者 (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,可通过 4. 参会者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": ""
}
}
9. 焦点视频 (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,可通过 4. 参会者id列表 (ListMemberIds) 获取 |
switch | 是 | bool | 是否开启焦点视频: |
输出参数(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": ""
}
}
10. 等候室准入成员 (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,可通过 4. 参会者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": ""
}
}
11. 结束录制 (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,可通过 4. 参会者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": ""
}
}
12. 锁定会议 (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": ""
}
}
13. 将成员移入等候室 (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,可通过 4. 参会者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": ""
}
}
14. 打开聊天窗口 (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": ""
}
}
15. 关闭聊天窗口 (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": ""
}
}
16. 打开字幕 (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": ""
}
}
17. 关闭字幕 (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": ""
}
}
18. 设置字幕参数 (SetCaptionParams)
接口说明
1)接口解释:用于会中设置字幕参数
2)引入版本: 3.13.190
3)调用方式(method):Call/MeetingControl
4)调用名(action):SetCaptionParams
5)前置依赖:
a. Rooms需要在会中
输入参数(action_params)
参数名称 | 是否必选 | 参数类型 | 参数描述 |
---|---|---|---|
current_font_size | 是 | int | 字号: |
source_language | 是 | int | 语言模式: |
translate_language | 是 | int | 翻译开关: |
two_language_is_check | 是 | bool | 是否同时显示双语: |
输出参数(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": ""
}
}