Call/MeetingControl

1) RequestRecord 请求录制

接口支持最低版本号:3.9.150

此接口异步返回调用结果,需要订阅 MeetingControl 事件
sub_event: RequestRecord

request

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

response

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

2) StartRecord  (启动录制)

接口支持最低版本号:3.9.150

此接口异步返回调用结果,需要订阅 MeetingControl 事件

request

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

response

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

3) MuteAll  (静音所有)

接口支持最低版本号:3.9.150

此接口异步返回调用结果,需要订阅 ControlMeeting 事件
sub_event: MuteAll

request

{
	"jsonrpc": "2.0",
	"id": "3FSWYMVSZRUXJXF",
	"method": "Call/MeetingControl",
	"params": {
		"action": "MuteAll",
		"action_params": {
			"audio_allow_unmute_by_self": false  //是否允许自我解除静音
		}
	}
}

response


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

4) ListMemberIds  (参会者id列表)

接口支持最低版本号:3.9.150

request

{
	"jsonrpc": "2.0",
	"id": "3FSWYMVSZRUXJXF",
	"method": "Call/MeetingControl",
	"params": {
		"action": "ListMemberIds",
		"action_params": {
			"begin_count": 0,  //0表示第一个人
			"type": 1,  //1:可见的参会者,0:等候室成员
			"end_count": 1,  //1表示第二个人
		}
	}
}

response

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

5) ChangeHost  (变更主持人)

接口支持最低版本号:3.9.150

此接口异步返回调用结果,需要订阅 Members 事件
sub_event: HostChanged

request

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

response

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

6) MuteMember  (静音参会者)

接口支持最低版本号:3.9.150

此接口异步返回调用结果,需要订阅 MeetingControl 事件
sub_event: UserUpdate

request

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

response

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

7) StopVideo  (关闭参会者视频)

接口支持最低版本号:3.9.150

此接口异步返回调用结果,需要订阅 MeetingControl 事件
sub_event: UserUpdate

request

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

response

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

8) RemoveMember  (移除参会者)

接口支持最低版本号:3.9.150

此接口异步返回调用结果,需要订阅 MeetingControl 事件
sub_event: UserRemove

request

{
	"jsonrpc": "2.0",
	"id": "3FSWYMVSZRUXJXF",
	"method": "Call/MeetingControl",
	"params": {
		"action": "RemoveMember",
		"action_params": {
			"user_id": "144115352466200111",
			"allow_join": true,//是否允许再加入
		}
	}
}

response

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

9) SpotLight  (焦点视频)

接口支持最低版本号:3.9.150

此接口异步返回调用结果,需要订阅 MeetingControl 事件
sub_event: SpotLight

request

{
	"jsonrpc": "2.0",
	"id": "3FSWYMVSZRUXJXF",
	"method": "Call/MeetingControl",
	"params": {
		"action": "SpotLight",
		"action_params": {
			"user_id": "144115352466200111",
			"switch": false, //是否开启焦点视频
		}
	}
}

response

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

10) AdmitMemberToMeeting  (等候室准入成员)

接口支持最低版本号:3.9.150

此接口异步返回调用结果,需要订阅 MeetingControl 事件

request

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

response

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

11) StopRecording  (结束录制)

接口支持最低版本号:3.13.190

此接口异步返回调用结果

request

{
    "jsonrpc": "2.0",
    "id": "2I42LO4PWY6KEPV",
    "method": "Call/MeetingControl", 
    "params": {
        "action": "StopRecording"
    }
}

response

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

12) LockMeeting  (锁定会议)

接口支持最低版本号:3.13.190

此接口异步返回调用结果

request

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

response

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

13) MoveToWaitingRoom  (将成员移入等候室)

接口支持最低版本号:3.13.190

此接口异步返回调用结果

request

{
    "jsonrpc": "2.0",
    "id": "T1G4O8H44SSFBN2",
    "method": "Call/MeetingControl", 
    "params": {
        "action": "MoveToWaitingRoom",
           "action_params": {
            "user_id": "144115263569321845"
         } 
    }
}

response

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

14) OpenChatWindow  (打开聊天窗口)

接口支持最低版本号:3.13.190

此接口异步返回调用结果

request

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

response

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

15) CloseChatWindow  (关闭聊天窗口)

接口支持最低版本号:3.13.190

此接口异步返回调用结果

request

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

response

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

16) OpenCaption  (打开字幕)

接口支持最低版本号:3.13.190

此接口异步返回调用结果

request

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

response

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

17) CloseCaption  (关闭字幕)

接口支持最低版本号:3.13.190

此接口异步返回调用结果

request

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

response

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

18) SetCaptionParams  (设置字幕参数)

接口支持最低版本号:3.13.190

此接口异步返回调用结果

request

{
    "jsonrpc": "2.0",
    "id": "M1FHYI38ODUG6IU",
    "method": "Call/MeetingControl", 
    "params": {
        "action": "SetCaptionParams",
           "action_params": {
            "current_font_size": int, // 字号,参考如下 current_font_size 定义
            "source_language": int, // 语言模式, 参考如下 source_language 定义
            "translate_language": int , // 翻译开关,参考如下 translate_language 定义
            "two_language_is_check": bool // 是否同时显示双语
         } 
    }
}

response

{
    "method": "Call/MeetingControl", 
    "result": {
        "error_code": 0, 
        "action": "SetCaptionParams", 
        "message": ""
    }, 
    "id": "M1FHYI38ODUG6IU", 
    "jsonrpc": "2.0"
}
current_font_size 字号
0
1
2
3 特大
source_language 语言模式
0 自动识别
1 中文
2 英文
translate_language 翻译
0 不翻译
1 中文
2 英文
下载 Call/MeetingControl.pdf
Copyright(C)2023 HFBangFu Inc. All Rights Reserved 皖ICP备12017563号-5