科达视讯平台会控API

1. 获取视频会议列表
2. 获取会议终端列表
3. 获取与会终端信息
4. 批量添加终端
5. 批量删除终端
6. 批量呼叫终端
7. 批量挂断终端
8. 获取会议主席
9. 指定会议主席
10. 获取会议发言人
11. 指定会议发言人
12. 获取会议双流源
13. 指定会议双流源
14. 取消会议双流源
15. 延长会议时间
16. 会场静音操作
17. 会场哑音操作
18. 会议安全操作
19. 修改会议名称
20. 发送短消息
21. 设置强制广播
22. 开启/关闭语音激励
23. 获取语音激励信息
24. 获取会议混音信息
25. 开启会议混音
26. 停止会议混音
27. 添加混音成员
28. 删除混音成员
29. 获取会议画面合成信息
30. 开启会议画面合成
31. 修改会议画面合成
32. 停止会议画面合成
33. 获取主席轮询信息
34. 开启主席轮询
35. 修改主席轮询状态
36. 获取会议轮询信息
37. 开启会议轮询
38. 修改会议轮询状态
39. 开启录像
40. 获取录像状态
41. 获取录像列表
42. 修改录像状态
43. 停止录像
44. 开始放像
45. 暂停、继续、停止放像
46. 调整放像进度
47. 获取会议放像状态
48. 开启终端自主画面合成
49. 获取终端自主画面合成信息
50. 修改终端自主画面合成参数
51. 停止终端自主画面合成
52. 获取开启自主画面合成的终端列表
53. 开启终端单通道自主画面合成
54. 获取终端单通道自主画面合成信息
55. 修改终端单通道自主画面合成参数
56. 停止终端单通道自主画面合成
57. 获取开启单通道自主画面合成的终端列表
64. 获取终端选看列表
65. 开启终端选看
66. 取消终端选看
67. 获取终端通道选看列表
68. 开启终端单通道选看
69. 取消终端单通道选看
70. 修改终端呼叫模式
71. 终端静音操作
72. 终端哑音操作
73. 修改终端音量
74. 终端摄像头控制
75. 获取终端视频源信息
76. 设置终端当前视频源
77. 设置VIP列表
78. 获取VIP列表
79. 获取用户域的vrs地址列表
80. 获取会控API版本信息
81. 设置双流模式

名称	获取视频会议列表
URI	/api/v1/vc/confs
方法	GET
说明	获取视频会议列表
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
own_conf	int	是否仅获取与自己相关的会议（自己为创建者或会议成员），默认为0 0-否； 1-是；
start	int	获取的视频会议列表的起始会议位置, 0表示第一个会议, 默认为0
count	int	获取的视频会议的个数, 即包括start在内的后count个会议, 0代表获取所有会议, 默认为10

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
total	int	总会议数
confs	array	会议列表
name	str	会议名称 最大字符长度：64个字节
user_domain_moid	str	会议所属的用户域moid
user_domain_name	str	会所属的的用户域名称
meeting_room_name	str	虚拟会议室名称，当返回为空字符串时说明不是召开的虚拟会议室
conf_id	str	会议号 最大字符长度：48个字节
conf_level	int	会议级别：1-16, 值越小, 级别越高(用于抢呼已在其他会议里的终端)
enable_rtc	int	是否允许RTC接入 0-关闭； 1-开启；
voice_activity_detection	int	是否开启语音激励 0-否； 1-是；
vacinterval	int	语音激励敏感度(s)，最小值3s, 开启语音激励时有效
conf_type	int	会议类型 0-传统； 1-端口； 2-SFU纯转发会议；
conf_category	int	会议类别 1-会管会议； 2-调度会议；
start_time	str	会议开始时间（ISO8601:2000格式表示）
end_time	str	会议结束时间（ISO8601:2000格式表示）
duration	int	会议时长 0为永久会议
bitrate	int	会议码率
closed_conf	int	会议免打扰 0-关闭； 1-开启；
safe_conf	int	会议安全 0-公开会议； 1-隐藏会议；
encrypted_type	int	传输加密类型 0-不加密； 2-AES加密； 5-量通(SM4_QT)； 6-量通(SM1_QT)；
encrypted_frequence	int	频度(仅量通模式下生效) 0-非量通； 1-一会一密； 2-一小时一密； 3-一分一密； 4-一秒一密；
encrypted_auth	int	终端双向认证 0-关闭； 1-开启；
mute	int	初始化哑音 0-否； 1-是；
mute_filter	int	全场哑音例外，参数为1时，若执行全场哑音操作，主席和发言人不会被哑音，若执行单个哑音操作时可以被哑音 0-否； 1-是；
force_mute	int	全场哑音下是否禁止终端取消自身哑音 0-否； 1-是；
anonymous_mt	int	是否支持匿名终端入会 0-否； 1-是；
silence	int	初始化静音 0-否； 1-是；
auto_end	int	自动结会(少于两个终端时自动结会) 0-不自动结会； 1-自动结会；
preoccupy_resource	int	预占资源模式(创会时就预占音视频适配器) 0-不预占模式； 1-预占模式； 2-SFU纯转发模式；
video_quality	int	视频质量 0-质量优先； 1-速度优先；
encrypted_key	str	传输加密AES加密密钥 最大字符长度：16字节
dual_mode	int	双流权限 0-发言会场； 1-任意会场； 2-指定会场；
public_conf	int	是否公共会议室 0-否； 1-是；
max_join_mt	int	最大与会终端数 8-小型8方会议； 32-32方会议； 64-64方会议； 192-大型192方会议；
force_broadcast	int	是否强制广播 0-不强制广播； 1-强制广播；
fec_mode	int	是否支持码流纠错 0-关闭； 1-开启；
need_password	int	是否需要密码 0-否； 1-是；
one_reforming	int	归一重整，开启该功能后可增强对外厂商终端的兼容，但会使丢包重传失效 0-不启用； 1-启用；
doubleflow	int	成为发言人后立即发起内容共享 0-否； 1-是；
platform_id	str	创会平台moid
superior_cascade	int	是否有上级级联会议室 0-否； 1-是；
subordinate_cascade	int	是否有下级级联会议室 0-否； 1-是；
meeting_id	str	视频会议唯一id
creator	object	会议发起者
name	str	名称 最大字符长度：128个字节
account	str	帐号 最大字符长度：128个字节
account_type	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号码； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
telephone	str	座机 最大字符长度：地区区号4位-字符电话16位-字符分机10位字符
mobile	str	手机 最大字符长度：15个字节

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取会议终端列表
URI	/api/v1/vc/confs/{conf_id}/mts
方法	GET
说明	获取会议终端列表
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
mts	array	终端数组
account	str	终端E164号,IP或电话号码
account_type	int	终端类型 5-e164号码； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
alias	str	终端别名 最大字符长度：128个字节
mt_id	str	终端号 最大字符长度：48个字节
ip	str	终端IP
online	int	是否在线 0-否； 1-是；
e164	str	终端E164号
type	int	终端类型 1-普通终端； 3-电话终端； 5-卫星终端； 7-下级会议； 8-上级会议；
bitrate	int	呼叫码率
silence	int	是否静音 0-否； 1-是；
mute	int	是否哑音 0-否； 1-是；
dual	int	是否在发送双流 0-否； 1-是；
mix	int	是否在混音 0-否； 1-是；
vmp	int	是否在合成 0-否； 1-是；
inspection	int	是否在选看 0-否； 1-是；
rec	int	是否在录像 0-否； 1-是；
poll	int	是否在轮询 0-否； 1-是；
upload	int	是否在上传 0-否； 1-是；
protocol	int	呼叫协议 0-323； 1-sip；
call_mode	int	呼叫模式 0-手动； 2-自动； 3-追呼；
v_snd_chn_num	int	终端发送码流数量
v_rcv_chn_num	int	终端接收码流数量

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取与会终端信息
URI	/api/v1/vc/confs/{conf_id}/mts/{mt_id}
方法	GET
说明	获取与会终端信息
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
account	str	终端E164号,IP或电话号码
account_type	int	终端类型 5-e164号码； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
alias	str	终端别名 最大字符长度：128个字节
mt_id	str	终端号 最大字符长度：48个字节
ip	str	终端IP
online	int	是否在线 0-否； 1-是；
e164	str	终端e164号
type	int	终端类型 1-普通终端； 3-电话终端； 5-卫星终端； 7-下级会议； 8-上级会议；
bitrate	int	呼叫码率
silence	int	是否静音 0-否； 1-是；
mute	int	是否哑音 0-否； 1-是；
dual	int	是否在发送双流 0-否； 1-是；
mix	int	是否在混音 0-否； 1-是；
vmp	int	是否在合成 0-否； 1-是；
inspection	int	是否在选看 0-否； 1-是；
rec	int	是否在录像 0-否； 1-是；
poll	int	是否在轮询 0-否； 1-是；
upload	int	是否在上传 0-否； 1-是；
protocol	int	呼叫协议，获取下级会议终端信息时不返回 0-323； 1-sip；
call_mode	int	呼叫模式，获取下级会议终端信息时不返回 0-手动； 2-自动； 3-追呼；
v_snd_chn	array	视频发送通道数组
chn_id	int	通道号
chn_alias	str	通道别名
bitrate	int	视频码率，获取级联终端信息时不返回
resolution	int	视频分辨率，详见《附录4.终端分辨率枚举值说明》，获取级联终端信息时不返回
format	int	视频格式，获取级联终端信息时不返回 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+;
cur_video_idx	int	当前终端发送的视频源通道号，获取级联终端信息时不返回
chn_label	int	通道标签 0-自动或未开启； 1-左边画面； 2-中间画面； 3-右边画面；
v_rcv_chn	array	视频接收通道数组
chn_id	int	通道号
chn_alias	str	通道别名
bitrate	int	视频码率，获取级联终端信息时不返回
resolution	int	视频分辨率，详见《附录4.终端分辨率枚举值说明》，获取级联终端信息时不返回
format	int	视频格式，获取级联终端信息时不返回 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+;
chn_label	int	通道标签 0-自动或未开启； 1-左边画面； 2-中间画面； 3-右边画面；
dv_snd_chn	array	双流视频通道数组
chn_id	int	通道号
chn_alias	str	通道别名
bitrate	int	双流码率，获取级联终端信息时不返回
resolution	int	双流分辨率，详见《附录4.终端分辨率枚举值说明》，获取级联终端信息时不返回
format	int	双流格式，获取级联终端信息时不返回 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+;
chn_label	int	通道标签 0-自动或未开启； 1-左边画面； 2-中间画面； 3-右边画面；
dv_rcv_chn	array	双流视频接收通道
chn_id	int	通道号
chn_alias	str	通道别名
bitrate	int	双流码率，获取级联终端信息时不返回
resolution	int	双流分辨率，详见《附录4.终端分辨率枚举值说明》，获取级联终端信息时不返回
format	int	双流格式，获取级联终端信息时不返回 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+;
chn_label	int	通道标签 0-自动或未开启； 1-左边画面； 2-中间画面； 3-右边画面；
a_rcv_chn	array	音频接收通道
chn_id	int	通道号
chn_alias	str	通道别名
chn_label	int	通道标签 0-自动或未开启； 1-左边画面； 2-中间画面； 3-右边画面；
a_snd_chn	array	音频发送通道
chn_id	int	通道号
chn_alias	str	通道别名
chn_label	int	通道标签 0-自动或未开启； 1-左边画面； 2-中间画面； 3-右边画面；
rcv_volume	int	接收音量
snd_volume	int	发送音量

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	批量添加终端
URI	/api/v1/vc/confs/{conf_id}/mts
方法	POST
说明	批量添加终端，添加终端为同步操作，等待终端上线为异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mts*	array	终端数组
account*	str	终端E164号,IP或电话号码
account_type*	int	终端类型 5-e164号码； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
bitrate*	int	呼叫码率
protocol*	int	呼叫协议 0-H323； 1-SIP； 2-rtc；
forced_call	int	是否强制呼叫，默认是0 0-不强呼； 1-强呼；
call_mode	int	呼叫模式，默认为创会时设置的呼叫模式 0-手动； 2-自动； 3-追呼；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
mts	array	终端数组，仅5.1.0.2版本而且是本级会议添加终端时，支持回复带此参数
account	str	终端E164号,IP或电话号码
account_type	int	终端类型 5-e164号码； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
protocol	int	呼叫协议，仅终端类型为IP地址时有效 0-H323； 1-SIP； 2-rtc；
mt_id	int	终端id

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	批量删除终端
URI	/api/v1/vc/confs/{conf_id}/mts
方法	DELETE
说明	批量删除终端，删除本级终端为同步操作，删除下级终端为异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mts*	array	终端数组
mt_id*	str	终端号 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	批量呼叫终端
URI	/api/v1/vc/confs/{conf_id}/online_mts
方法	POST
说明	批量呼叫终端，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mts*	array	终端数组
mt_id*	str	终端号 最大字符长度：48个字节
forced_call	int	是否强制呼叫，默认是0 0-不强呼； 1-强呼；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	批量挂断终端
URI	/api/v1/vc/confs/{conf_id}/online_mts
方法	DELETE
说明	批量挂断终端，同步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mts*	array	终端数组
mt_id*	str	终端号 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	获取会议主席
URI	/api/v1/vc/confs/{conf_id}/chairman
方法	GET
说明	获取会议主席
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
mt_id	str	主席id 最大字符长度：48个字节

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	指定会议主席
URI	/api/v1/vc/confs/{conf_id}/chairman
方法	PUT
说明	仅支持本级会议终端设置为会议主席，同步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mt_id*	str	设置主席的终端号，取消主席填空 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	获取会议发言人
URI	/api/v1/vc/confs/{conf_id}/speaker
方法	GET
说明	获取会议发言人
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
mt_id	str	发言人id 最大字符长度：48个字节
force_broadcast	int	是否设置发言人强制广播，仅SFU会议有效，默认为0 0-否； 1-是；

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	指定会议发言人
URI	/api/v1/vc/confs/{conf_id}/speaker
方法	PUT
说明	指定会议发言人，同步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mt_id*	str	设置发言人的终端号，取消发言人填空 最大字符长度：48个字节
force_broadcast	int	是否设置发言人强制广播，仅SFU会议有效，默认为0 0-否； 1-是；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	获取会议双流源
URI	/api/v1/vc/confs/{conf_id}/dualstream
方法	GET
说明	获取会议双流源
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
mt_id	str	双流源 最大字符长度：48个字节

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	指定会议双流源
URI	/api/v1/vc/confs/{conf_id}/dualstream
方法	PUT
说明	指定会议双流源，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mt_id*	str	发双流的终端, 为空则取消会议双流源 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	取消会议双流源
URI	/api/v1/vc/confs/{conf_id}/dualstream
方法	DELETE
说明	取消会议双流源，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mt_id*	str	发双流的终端 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	延长会议时间
URI	/api/v1/vc/confs/{conf_id}/delay
方法	POST
说明	延长会议时间，同步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
delay_time*	int	延长的时间，单位：分钟

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	会场静音操作
URI	/api/v1/vc/confs/{conf_id}/silence
方法	PUT
说明	会场静音操作，同步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
value*	int	静音状态 0-停止静音； 1-静音；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	会场哑音操作
URI	/api/v1/vc/confs/{conf_id}/mute
方法	PUT
说明	会场哑音操作，同步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
value*	int	哑音状态 0-停止哑音； 1-哑音；
force_mute*	int	全场哑音下是否禁止终端取消自身哑音 默认为0 0-否； 1-是；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	会议安全操作
URI	/api/v1/vc/confs/{conf_id}/safty
方法	PUT
说明	会议安全操作，同步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
password*	str	密码字符串（加密待定） 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：16个字节
safe_conf*	int	会议开放模式 0-公开会议； 1-隐藏会议；
closed_conf*	int	会议免打扰 0-关闭； 1-开启；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	修改会议名称
URI	/api/v1/vc/confs/{conf_id}/name
方法	POST
说明	修改会议名称，同步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
value*	str	会议名称 1.字符限制：   a.不支持输入特殊字符：% & * ^ ~ ' " " ? / \ < > | ` " $   b.且首字符和尾字符不支持输入，下划线（_） 减号（-） 小数点（.） @ （除首尾字符可以输入） 2.最大字符长度：64个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	发送短消息
URI	/api/v1/vc/confs/{conf_id}/sms
方法	POST
说明	发送短消息，SFU会议不支持该功能
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
message*	str	消息内容,发送空消息即停止短消息 最大字符长度：1500个字节
roll_num*	int	滚动次数 1-255 新版本终端255为无限轮询
roll_speed*	int	滚动速度 1-慢速； 2-中速； 3-快速；
type*	int	短消息类型 0-自右至左滚动； 1-翻页滚动； 2-全页滚动；
mts*	array	接收消息的终端数组
mt_id*	str	终端号 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	设置强制广播
URI	/api/v1/vc/confs/{conf_id}/forcebroadcast
方法	PUT
说明	设置是否强制广播
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
force_broadcast*	int	是否强制广播 0-不强制广播； 1-强制广播；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	开启/关闭语音激励
URI	/api/v1/vc/confs/{conf_id}/vad
方法	PUT
说明	开启/关闭语音激励，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
state*	int	语音激励 0-关闭； 1-开启；
vacinterval*	int	语音激励敏感度(s)，最小值3s

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	获取语音激励信息
URI	/api/v1/vc/confs/{conf_id}/vad
方法	GET
说明	获取语音激励信息
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
voice_activity_detection	int	是否开启语音激励 0-否； 1-是；
vacinterval	int	语音激励敏感度(s)，最小值3s, 开启语音激励时有效

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	获取会议混音信息
URI	/api/v1/vc/confs/{conf_id}/mixs/{mix_id}
方法	GET
说明	获取会议混音信息
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
mode	int	混音模式 1-智能混音； 2-定制混音；
members	array	混音成员数组
account	str	成员呼叫别名
mt_id	str	成员终端号，当成员不在会议中时返回空字符串 最大字符长度：48个字节

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	开启会议混音
URI	/api/v1/vc/confs/{conf_id}/mixs
方法	POST
说明	开启会议混音，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mode*	int	混音模式 1-智能混音； 2-定制混音；
members*	array	混音成员数组
mt_id	str	成员终端号 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	停止会议混音
URI	/api/v1/vc/confs/{conf_id}/mixs/{mix_id}
方法	DELETE
说明	会议主混音器，默认mix_id为1，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	添加混音成员
URI	/api/v1/vc/confs/{conf_id}/mixs/{mix_id}/members
方法	POST
说明	会议主混音器，默认mix_id为1，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
members*	array	混音成员数组
mt_id	str	成员终端号 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	删除混音成员
URI	/api/v1/vc/confs/{conf_id}/mixs/{mix_id}/members
方法	DELETE
说明	会议主混音器，默认mix_id为1，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
members*	array	混音成员数组
mt_id	str	成员终端号 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	获取会议画面合成信息
URI	/api/v1/vc/confs/{conf_id}/vmps/{vmp_id}
方法	GET
说明	获取会议画面合成信息,当未开启画面合成时返回错误
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
mode	int	画面合成模式 1-定制画面合成； 2-自动画面合成； 3-自动画面合成批量轮询； 4-定制画面合成批量轮询；
except_self	int	是否开启自动画面合成n-1模式, 即不显示自己的画面, 仅自动画面合成时有效,默认为0 0-否； 1-是；
layout	int	画面合成风格: 1-一画面全屏; 2-两画面: 2等大，居中(1行2列); 3-两画面: 1大1小，1大全屏，1小右下; 61-两画面: 1大1小，1大全屏，1小右上; 62-两画面: 1大1小，1大全屏，1小左上; 63-两画面: 1大1小，1大全屏，1小左下; 23-三画面: 等大，1左，2右(2行1列); 4-三画面: 等大，1上2下; 5-四画面: 等大，2行2列; 34-五画面: 1大4小，1大左，4小右(4行1列); 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列); 64-六画面: 1大5小，1大左，2小右(5行1列)，3小下(1行3列); 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列); 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列); 8-九画面: 等大，3行3列; 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列); 38-十一画面: 1大10小，1大上，10小下(2行5列); 65-十一画面: 3大8小，3大上（一行三列），8小下(2行4列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列); 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列); 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列); 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列); 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下（1行6列）; 11-十六画面: 16等分，4x4; 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列); 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列); 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列); 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列); 54-二十一画面: 1大20小，6小上(1行6列)，4小左中(4行1列)，1大中中，4小右中(4行1列)，6小下(1行6列); 56-二十二画面: 1大21小，1大左上，6小右上(2行3列)，15小下(3行5列); 59-二十四画面: 4大20小，6小上(1行6列)，4小左中(4行1列)，4大中中(2行2列)，4小右中(4行1列)，6小下(1行6列)； 27-二十五画面: 等大，5行5列;
broadcast	int	是否广播 0-不广播； 1-广播；
voice_hint	int	是否识别声音来源 0-否； 1-是；
show_mt_name	int	是否显示别名 0-不显示； 1-显示；
mt_name_style	object	画面合成台标参数
font_size	int	台标字体大小 0-小； 1-中； 2-大；
font_color	str	台标字体三原色#RGB格式, 十六进制表示, 默认为: #FFFFFF白色
position	int	台标显示位置, 默认为: 1 0-左上角； 1-左下角； 2-右上角； 3-右下角； 4-底部中间；
members	array	画面合成成员数组
chn_idx	int	画面合成通道索引，从0开始
member_type	int	成员类型 1-会控指定； 2-发言人跟随； 3-管理方跟随； 4-会议轮询跟随； 5-自动语音激励； 6-单通道轮询； 7-双流跟随；
account	str	成员呼叫别名
mt_id	str	成员终端号，当成员不在会议中时返回空字符串 最大字符长度：48个字节
mt_chn_idx	int	终端视频通道号，仅成员类型为会控指定时有效，0为自动选择，默认值为0
poll	object	单通道轮询参数，仅member_type为6时返回
num	int	画面合成单通道轮询次数
keep_time	int	画面合成单通道轮询间隔时间,单位：秒
poll_index	int	正在轮询的终端顺序索引，当为0时表示当前轮询终端无效
members	array	单通道轮询成员数组，返回顺序与实际单通道轮询顺序相符
account	str	成员呼叫别名
mt_id	str	成员终端号，当成员不在会议中时返回空字符串 最大字符长度：48个字节
poll	object	画面合成批量轮询信息,当mode为3、4时返回
num	int	画面合成批量轮询次数
keep_time	int	画面合成批量轮询间隔时间,单位：秒
members	array	批量轮询成员数组,当mode为4时返回
account	str	成员呼叫别名
mt_id	str	成员终端号，当成员不在会议中时返回空字符串 最大字符长度：48个字节

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	开启会议画面合成
URI	/api/v1/vc/confs/{conf_id}/vmps
方法	POST
说明	开启会议画面合成，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mode*	int	画面合成模式 1-定制画面合成； 2-自动画面合成； 3-自动画面合成批量轮询； 4-定制画面合成批量轮询；
except_self*	int	是否开启自动画面合成n-1模式, 即不显示自己的画面, 仅自动画面合成时有效,默认为0 0-否； 1-是；
layout*	int	画面合成风格: 1-一画面全屏; 2-两画面: 2等大，居中(1行2列); 3-两画面: 1大1小，1大全屏，1小右下; 61-两画面: 1大1小，1大全屏，1小右上; 62-两画面: 1大1小，1大全屏，1小左上; 63-两画面: 1大1小，1大全屏，1小左下; 23-三画面: 等大，1左，2右(2行1列); 4-三画面: 等大，1上2下; 5-四画面: 等大，2行2列; 34-五画面: 1大4小，1大左，4小右(4行1列); 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列); 64-六画面: 1大5小，1大左，2小右(5行1列)，3小下(1行3列); 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列); 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列); 8-九画面: 等大，3行3列; 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列); 38-十一画面: 1大10小，1大上，10小下(2行5列); 65-十一画面: 3大8小，3大上（一行三列），8小下(2行4列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列); 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列); 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列); 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列); 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下（1行6列）; 11-十六画面: 16等分，4x4; 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列); 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列); 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列); 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列); 54-二十一画面: 1大20小，6小上(1行6列)，4小左中(4行1列)，1大中中，4小右中(4行1列)，6小下(1行6列); 56-二十二画面: 1大21小，1大左上，6小右上(2行3列)，15小下(3行5列); 59-二十四画面: 4大20小，6小上(1行6列)，4小左中(4行1列)，4大中中(2行2列)，4小右中(4行1列)，6小下(1行6列)； 27-二十五画面: 等大，5行5列;
broadcast*	int	是否广播 0-否； 1-是；
voice_hint*	int	是否识别声音来源 0-否； 1-是；
show_mt_name*	int	是否显示别名 0-否； 1-是；
mt_name_style	object	画面合成台标参数
font_size	int	台标字体大小, 默认为: 0 0-小； 1-中； 2-大；
font_color	str	台标字体三原色#RGB格式, 十六进制表示, 默认为: #FFFFFF白色
position	int	台标显示位置, 默认为: 1 0-左上角； 1-左下角； 2-右上角； 3-右下角； 4-底部中间；
members*	array	画面合成成员数组
chn_idx*	int	画面合成通道索引，从0开始
member_type*	int	成员类型 1-会控指定； 2-发言人跟随； 3-主席跟随； 4-轮询跟随； 6-单通道轮询； 7-双流跟随；
mt_id*	str	通道终端号，仅当通道中为会控指定时需要 最大字符长度：48个字节
mt_chn_idx	int	终端视频通道号，仅成员类型为会控指定时有效，0为自动选择，默认值为0
poll	object	单通道轮询参数，仅member_type为6时有效
num*	int	画面合成单通道轮询次数
keep_time*	int	画面合成单通道轮询间隔时间,单位：秒
poll_index	int	开始轮询的终端顺序索引，默认为1
members	array	单通道轮询成员数组
mt_id*	str	成员终端号 最大字符长度：48个字节
poll	object	画面合成批量轮询信息,仅mode为3、4时有效
num*	int	画面合成批量轮询次数
keep_time*	int	画面合成批量轮询间隔时间,单位：秒
members	array	批量轮询成员数组,仅mode为4时有效
mt_id*	str	成员终端号 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	修改会议画面合成
URI	/api/v1/vc/confs/{conf_id}/vmps/{vmp_id}
方法	POST
说明	会议主画面合成，默认vmp_id为1，异步操作，当未开启画面合成时返回错误
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mode*	int	画面合成模式 1-定制画面合成； 2-自动画面合成； 3-自动画面合成批量轮询； 4-定制画面合成批量轮询；
except_self*	int	是否开启自动画面合成n-1模式, 即不显示自己的画面, 仅自动画面合成时有效,默认为0 0-否； 1-是；
layout*	int	画面合成风格: 1-一画面全屏; 2-两画面: 2等大，居中(1行2列); 3-两画面: 1大1小，1大全屏，1小右下; 61-两画面: 1大1小，1大全屏，1小右上; 62-两画面: 1大1小，1大全屏，1小左上; 63-两画面: 1大1小，1大全屏，1小左下; 23-三画面: 等大，1左，2右(2行1列); 4-三画面: 等大，1上2下; 5-四画面: 等大，2行2列; 34-五画面: 1大4小，1大左，4小右(4行1列); 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列); 64-六画面: 1大5小，1大左，2小右(5行1列)，3小下(1行3列); 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列); 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列); 8-九画面: 等大，3行3列; 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列); 38-十一画面: 1大10小，1大上，10小下(2行5列); 65-十一画面: 3大8小，3大上（一行三列），8小下(2行4列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列); 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列); 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列); 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列); 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下（1行6列）; 11-十六画面: 16等分，4x4; 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列); 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列); 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列); 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列); 54-二十一画面: 1大20小，6小上(1行6列)，4小左中(4行1列)，1大中中，4小右中(4行1列)，6小下(1行6列); 56-二十二画面: 1大21小，1大左上，6小右上(2行3列)，15小下(3行5列); 59-二十四画面: 4大20小，6小上(1行6列)，4小左中(4行1列)，4大中中(2行2列)，4小右中(4行1列)，6小下(1行6列)； 27-二十五画面: 等大，5行5列;
broadcast*	int	是否广播 0-否； 1-是；
voice_hint*	int	是否识别声音来源 0-否； 1-是；
show_mt_name*	int	是否显示别名 0-否； 1-是；
mt_name_style*	object	画面合成台标参数
font_size	int	台标字体大小, 默认为: 0 0-小； 1-中； 2-大；
font_color	str	台标字体三原色#RGB格式, 十六进制表示, 默认为: #FFFFFF白色
position	int	台标显示位置, 默认为: 1 0-左上角； 1-左下角； 2-右上角； 3-右下角； 4-底部中间；
members*	array	画面合成成员数组
chn_idx*	int	画面合成通道索引，从0开始
member_type*	int	成员类型 1-会控指定； 2-发言人跟随； 3-主席跟随； 4-轮询跟随； 6-单通道轮询； 7-双流跟随；
mt_id*	str	通道终端号，仅当通道中为会控指定时需要 最大字符长度：48个字节
mt_chn_idx	int	终端视频通道号，仅成员类型为会控指定时有效，0为自动选择，默认值为0
poll	object	单通道轮询参数，仅member_type为6时有效
num*	int	画面合成批量轮询次数
keep_time*	int	画面合成批量轮询间隔时间,单位：秒
poll_index	int	修改正在轮训的终端顺序索引，0为不修改顺序，默认为0
members*	array	单通道轮询成员数组
mt_id*	str	成员终端号 最大字符长度：48个字节
poll	object	画面合成轮询信息,仅mode为3、4时有效
num*	int	画面合成批量轮询次数
keep_time*	int	画面合成批量轮询间隔时间,单位：秒
members*	array	批量轮询成员数组,仅mode为4时有效
mt_id*	str	成员终端号 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	停止会议画面合成
URI	/api/v1/vc/confs/{conf_id}/vmps/{vmp_id}
方法	DELETE
说明	会议主画面合成，默认vmp_id为1，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	获取主席轮询信息
URI	/api/v1/vc/confs/{conf_id}/chairman_poll
方法	GET
说明	获取主席轮询信息
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
mode	int	轮询模式 10-主席视频轮询； 11-主席音视频轮询；
state	int	轮询状态 0-未轮询； 1-正常轮询； 2-轮询暂停；
num	int	轮询次数，0为一直轮询
keep_time	int	轮询时间，单位：秒
poll_index	int	当前轮询的终端顺序索引，当为0时表示当前轮询终端无效
cur_poll_mt	object	当前轮询的终端
mt_id	str	终端号 最大字符长度：48个字节
members	array	轮询终端数组
account	str	成员呼叫别名
mt_id	str	成员终端号，当成员不在会议中时返回空字符串 最大字符长度：48个字节

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	开启主席轮询
URI	/api/v1/vc/confs/{conf_id}/chairman_poll
方法	PUT
说明	开启主席轮询，SFU会议不支持该功能，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mode*	int	轮询模式 10-主席视频轮询； 11-主席音视频轮询；
num*	int	轮询次数，0为一直轮询
keep_time*	int	轮询时间，单位：秒
poll_index	int	开始轮询的终端顺序索引，默认为1
members*	array	轮询终端数组
mt_id	str	终端号 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	修改主席轮询状态
URI	/api/v1/vc/confs/{conf_id}/chairman_poll/state
方法	PUT
说明	修改主席轮询状态，SFU会议不支持该功能，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
value*	int	轮询状态 0-停止轮询； 1-暂停轮询； 2-继续轮询；
mode*	int	轮询模式 10-主席视频轮询； 11-主席音视频轮询；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	获取会议轮询信息
URI	/api/v1/vc/confs/{conf_id}/poll
方法	GET
说明	获取会议轮询信息
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
mode	int	轮询模式 1-视频轮询； 3-音视频轮询； 6-轮询视频:只给回传通道； 7-轮询发言人：只给回传通道； 8-轮询视频：给回传通道和本地广播； 9-轮询发言人：给回传通道和本地广播；
state	int	轮询状态 0-未轮询； 1-正常轮询； 2-轮询暂停；
num	int	轮询次数，0为一直轮询
keep_time	int	轮询时间，单位：秒
poll_index	int	轮询的终端顺序索引，当为0时表示当前轮询终端无效
cur_poll_mt	object	当前轮询的终端
mt_id	str	终端号 最大字符长度：48个字节
members	array	轮询终端数组
account	str	成员呼叫别名
mt_id	str	成员终端号，当成员不在会议中时返回空字符串 最大字符长度：48个字节

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	开启会议轮询
URI	/api/v1/vc/confs/{conf_id}/poll
方法	PUT
说明	开启会议轮询，SFU会议不支持该功能，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mode*	int	轮询模式 1-视频轮询； 3-音视频轮询；
num*	int	轮询次数，0为一直轮询
keep_time*	int	轮询时间，单位：秒
poll_index	int	开始轮询的终端顺序索引，默认为1
members*	array	轮询终端数组
mt_id	str	终端号 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	修改会议轮询状态
URI	/api/v1/vc/confs/{conf_id}/poll/state
方法	PUT
说明	修改轮询状态，SFU会议不支持该功能，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
value*	int	轮询状态 0-停止轮询； 1-暂停轮询； 2-继续轮询；
mode*	int	轮询模式 1-视频轮询； 3-音视频轮询；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	开启录像
URI	/api/v1/vc/confs/{conf_id}/recorders
方法	POST
说明	开启录像，SFU会议不支持该功能，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
video_name*	str	录像保存的文件名称 1.字符限制：   a.不支持输入特殊字符 % : & * ^ ~ ' "" ? / \ < > | ` " $   b.首字符和尾字符，不允许输入下划线（_） 减号（-） @ 小数点（.） （可输入在非首尾字符） 2.最大字符长度：64个字节
recorder_type*	int	录像类型 1-会议录像； 2-终端录像；
publish_mode*	int	发布模式 0-不发布； 1-发布；
watermark*	int	是否添加水印 0-不添加水印； 1-添加水印；
anonymous*	int	是否支持免登陆观看直播 0-不支持； 1-支持；
recorder_mode*	int	录像模式 1-录像； 2-直播； 3-录像+直播；
main_stream*	int	是否录主格式码流（视频+音频） 0-否； 1-是；
dual_stream*	int	是否录双流（仅双流） 0-否； 1-是；
vrs_id*	str	vrs的id信息,用于指定录像的vrs
members	array	开启录像终端数组 仅当开启终端录像需要填写
mt_id	str	终端id, 最大字符长度：48个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
rec_id	str	录像机id

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

名称	获取录像状态
URI	/api/v1/vc/confs/{conf_id}/recorders/{rec_id}
方法	GET
说明	获取录像状态，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
video_name	str	录像文件名 最大字符长度：128个字节
recorder_type	int	录像类型 1-会议录像； 2-终端录像；
state	int	录像状态 0-未录像； 1-正在录像； 2-暂停； 3-正在呼叫实体； 4-准备录像；
anonymous	int	是否支持免登陆观看直播 0-不支持； 1-支持；
recorder_mode	int	录像模式 1-录像； 2-直播； 3-录像+直播；
main_stream	int	是否录主格式码流（视频+音频） 0-是； 1-否；
dual_stream	int	是否录双流 0-是； 1-否；
watermark	int	是否添加水印 0-不添加水印； 1-添加水印；
publish_mode	int	发布类型 0-不发布； 1-发布；
current_progress	int	当前录像进度, 单位为: 秒
members	array	获取录像状态终端数组
mt_id	str	终端id, 仅当开启终端录像需要 最大字符长度：48个字节

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取录像列表
URI	/api/v1/vc/confs/{conf_id}/recorders
方法	GET
说明	获取录像列表
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
recorders	array	录像列表
rec_id	str	录像机id 最大字符长度：48字节
video_name	str	录像文件名 最大字符长度：128字节
recorder_type	int	录像类型 1-会议录像； 2-终端录像；
state	int	录像状态 0-未录像； 1-正在录像； 2-暂停； 3-正在呼叫实体； 4-准备录像；
anonymous	int	是否支持免登陆观看直播 0-不支持； 1-支持；
recorder_mode	int	录像模式 1-录像； 2-直播； 3-录像+直播；
main_stream	int	是否录主格式码流（视频+音频） 0-否； 1-是；
dual_stream	int	是否录双流 0-否； 1-是；
publish_mode	int	发布类型 0-不发布； 1-发布；
watermark	int	是否添加水印 0-不添加水印； 1-添加水印；
current_progress	int	当前录像进度, 单位为: 秒
members	array	获取录像终端数组
mt_id	str	终端id, 仅当开启终端录像需要 最大字符长度：48个字节

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	修改录像状态
URI	/api/v1/vc/confs/{conf_id}/recorders/{rec_id}/state
方法	PUT
说明	修改录像状态，SFU会议不支持该功能，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
value*	int	录像状态 1-暂停录像； 2-继续录像；
recorder_mode*	int	录像模式 1-录像； 2-直播； 3-录像+直播；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	停止录像
URI	/api/v1/vc/confs/{conf_id}/recorders/{rec_id}
方法	DELETE
说明	停止录像，SFU会议不支持该功能，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
recorder_mode*	int	录像模式 1-录像； 2-直播； 3-录像+直播；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	开始放像
URI	/api/v1/vc/confs/{conf_id}/playback
方法	PUT
说明	开始放像，SFU会议不支持该功能，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
play_dual_stream*	int	是否播放双流 0-否； 1-是；
file_name*	str	放像文件名，最大128字节
file_id*	int	播放文件的文件id
vrs_id*	str	vrs的id信息,用于指定放像的vrs

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
rec_id	str	录像机id

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	暂停、继续、停止放像
URI	/api/v1/vc/confs/{conf_id}/playback/state
方法	PUT
说明	暂停、继续、停止放像，SFU会议不支持该功能，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
value*	int	放像状态 0-未放像； 1-暂停放像； 2-正在放像；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	调整放像进度
URI	/api/v1/vc/confs/{conf_id}/playback/current_progress
方法	PUT
说明	调整放像进度，SFU会议不支持该功能，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	软件权限token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
current_progress*	int	调整的进度,单位：秒

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取会议放像状态
URI	/api/v1/vc/confs/{conf_id}/playback
方法	GET
说明	获取会议放像状态
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
file_name	str	放像文件名
file_id	int	播放文件的文件id
state	int	放像状态 0-未放像； 1-暂停播放； 2-正在放像； 3-准备播放； 4-正在呼叫实体；
current_progress	int	当前进度，单位：秒
total_time	int	文件总时长，单位：秒

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	开启终端自主画面合成
URI	/api/v1/vc/confs/{conf_id}/mtvmps
方法	POST
说明	仅端口会议有用，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mode*	int	自主画面合成模式 1-定制画面合成； 2-自动画面合成；
layout*	int	画面合成风格: 1-一画面全屏; 2-两画面: 2等大，居中(1行2列); 3-两画面: 1大1小，1大全屏，1小右下; 61-两画面: 1大1小，1大全屏，1小右上; 62-两画面: 1大1小，1大全屏，1小左上; 63-两画面: 1大1小，1大全屏，1小左下; 23-三画面: 等大，1左，2右(2行1列); 4-三画面: 等大，1上2下; 5-四画面: 等大，2行2列; 34-五画面: 1大4小，1大左，4小右(4行1列); 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列); 64-六画面: 1大5小，1大左，2小右(5行1列)，3小下(1行3列); 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列); 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列); 8-九画面: 等大，3行3列; 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列); 38-十一画面: 1大10小，1大上，10小下(2行5列); 65-十一画面: 3大8小，3大上（一行三列），8小下(2行4列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列); 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列); 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列); 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列); 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下（1行6列）; 11-十六画面: 16等分，4x4; 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列); 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列); 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列); 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列); 54-二十一画面: 1大20小，6小上(1行6列)，4小左中(4行1列)，1大中中，4小右中(4行1列)，6小下(1行6列); 56-二十二画面: 1大21小，1大左上，6小右上(2行3列)，15小下(3行5列); 59-二十四画面: 4大20小，6小上(1行6列)，4小左中(4行1列)，4大中中(2行2列)，4小右中(4行1列)，6小下(1行6列)； 27-二十五画面: 等大，5行5列;
mt_id*	str	开启自主画面合成的终端号 最大字符长度：48字节
voice_hint*	int	是否识别声音来源 0-否； 1-是；
show_mt_name*	int	是否显示别名 0-不显示； 1-显示；
members	array	自主画面合成成员数组
chn_idx*	int	自主画面合成通道索引，从0开始
member_type*	int	成员类型 0-空； 1-会控指定；
mt_id*	str	通道终端号 最大字符长度：48个字节
mt_chn_idx	int	终端通道, 0为自动选择，默认为0

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取终端自主画面合成信息
URI	/api/v1/vc/confs/{conf_id}/mtvmps/{mt_id}
方法	GET
说明	仅端口会议有用，当未开启画面合成时会返回错误
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
mode	int	自主画面合成模式 1-定制画面合成； 2-自动画面合成；
layout	int	画面合成风格: 1-一画面全屏; 2-两画面: 2等大，居中(1行2列); 3-两画面: 1大1小，1大全屏，1小右下; 61-两画面: 1大1小，1大全屏，1小右上; 62-两画面: 1大1小，1大全屏，1小左上; 63-两画面: 1大1小，1大全屏，1小左下; 23-三画面: 等大，1左，2右(2行1列); 4-三画面: 等大，1上2下; 5-四画面: 等大，2行2列; 34-五画面: 1大4小，1大左，4小右(4行1列); 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列); 64-六画面: 1大5小，1大左，2小右(5行1列)，3小下(1行3列); 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列); 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列); 8-九画面: 等大，3行3列; 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列); 38-十一画面: 1大10小，1大上，10小下(2行5列); 65-十一画面: 3大8小，3大上（一行三列），8小下(2行4列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列); 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列); 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列); 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列); 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下（1行6列）; 11-十六画面: 16等分，4x4; 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列); 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列); 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列); 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列); 54-二十一画面: 1大20小，6小上(1行6列)，4小左中(4行1列)，1大中中，4小右中(4行1列)，6小下(1行6列); 56-二十二画面: 1大21小，1大左上，6小右上(2行3列)，15小下(3行5列); 59-二十四画面: 4大20小，6小上(1行6列)，4小左中(4行1列)，4大中中(2行2列)，4小右中(4行1列)，6小下(1行6列)； 27-二十五画面: 等大，5行5列;
voice_hint	int	是否识别声音来源 0-否； 1-是；
show_mt_name	int	是否显示别名 0-不显示； 1-显示；
mt_chn_idx	int	自主画面合成终端接收的终端通道, 0为自动选择，默认为0
members	array	自主画面合成成员数组
chn_idx	int	自主画面合成通道索引，从0开始
member_type	int	成员类型 0-空； 1-会控指定； 2-发言人跟随； 3-管理方跟随； 4-会议轮询跟随； 5-自动语音激励； 6-单通道轮询； 7-双流跟随；
mt_id	str	通道终端号，仅当通道中为会控指定时有效，当成员不在会议中时返回空字符串 最大字符长度：48个字节
mt_chn_idx	int	终端发送的通道, 0为自动选择，默认为0
account	str	成员呼叫别名

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	修改终端自主画面合成参数
URI	/api/v1/vc/confs/{conf_id}/mtvmps/{mt_id}
方法	PUT
说明	仅端口会议有用，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mode*	int	自主画面合成模式 1-定制画面合成； 2-自动画面合成；
layout*	int	画面合成风格: 1-一画面全屏; 2-两画面: 2等大，居中(1行2列); 3-两画面: 1大1小，1大全屏，1小右下; 61-两画面: 1大1小，1大全屏，1小右上; 62-两画面: 1大1小，1大全屏，1小左上; 63-两画面: 1大1小，1大全屏，1小左下; 23-三画面: 等大，1左，2右(2行1列); 4-三画面: 等大，1上2下; 5-四画面: 等大，2行2列; 34-五画面: 1大4小，1大左，4小右(4行1列); 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列); 64-六画面: 1大5小，1大左，2小右(5行1列)，3小下(1行3列); 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列); 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列); 8-九画面: 等大，3行3列; 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列); 38-十一画面: 1大10小，1大上，10小下(2行5列); 65-十一画面: 3大8小，3大上（一行三列），8小下(2行4列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列); 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列); 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列); 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列); 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下（1行6列）; 11-十六画面: 16等分，4x4; 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列); 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列); 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列); 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列); 54-二十一画面: 1大20小，6小上(1行6列)，4小左中(4行1列)，1大中中，4小右中(4行1列)，6小下(1行6列); 56-二十二画面: 1大21小，1大左上，6小右上(2行3列)，15小下(3行5列); 59-二十四画面: 4大20小，6小上(1行6列)，4小左中(4行1列)，4大中中(2行2列)，4小右中(4行1列)，6小下(1行6列)； 27-二十五画面: 等大，5行5列;
voice_hint*	int	是否识别声音来源 0-否； 1-是；
show_mt_name*	int	是否显示别名 0-不显示； 1-显示；
members	array	自主画面合成成员数组
chn_idx*	int	自主画面合成通道索引，从0开始
member_type*	int	成员类型 0-空； 1-会控指定；
mt_id*	str	通道终端号 最大字符长度：48个字节
mt_chn_idx	int	终端通道, 0为自动选择，默认为0

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	停止终端自主画面合成
URI	/api/v1/vc/confs/{conf_id}/mtvmps/{mt_id}
方法	DELETE
说明	仅端口会议有用，异步操作
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取开启自主画面合成的终端列表
URI	/api/v1/vc/confs/{conf_id}/mtvmps
方法	GET
说明	获取开启自主画面合成的终端列表，当未开启画面合成时会返回错误
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
mts	array	开启自主画面合成的终端数组
mode	int	自主画面合成模式 1-定制画面合成； 2-自动画面合成；
layout	int	画面合成风格: 1-一画面全屏; 2-两画面: 2等大，居中(1行2列); 3-两画面: 1大1小，1大全屏，1小右下; 61-两画面: 1大1小，1大全屏，1小右上; 62-两画面: 1大1小，1大全屏，1小左上; 63-两画面: 1大1小，1大全屏，1小左下; 23-三画面: 等大，1左，2右(2行1列); 4-三画面: 等大，1上2下; 5-四画面: 等大，2行2列; 34-五画面: 1大4小，1大左，4小右(4行1列); 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列); 64-六画面: 1大5小，1大左，2小右(5行1列)，3小下(1行3列); 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列); 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列); 8-九画面: 等大，3行3列; 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列); 38-十一画面: 1大10小，1大上，10小下(2行5列); 65-十一画面: 3大8小，3大上（一行三列），8小下(2行4列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列); 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列); 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列); 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列); 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下（1行6列）; 11-十六画面: 16等分，4x4; 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列); 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列); 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列); 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列); 54-二十一画面: 1大20小，6小上(1行6列)，4小左中(4行1列)，1大中中，4小右中(4行1列)，6小下(1行6列); 56-二十二画面: 1大21小，1大左上，6小右上(2行3列)，15小下(3行5列); 59-二十四画面: 4大20小，6小上(1行6列)，4小左中(4行1列)，4大中中(2行2列)，4小右中(4行1列)，6小下(1行6列)； 27-二十五画面: 等大，5行5列;
show_mt_name	int	是否显示别名 0-不显示； 1-显示；
voice_hint	int	是否识别声音来源 0-否； 1-是；
mt_id	str	开启自主画面合成的终端号 最大字符长度：48个字节
mt_chn_idx	int	自主画面合成终端接收的终端通道, 0为自动选择，默认为0

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	开启终端单通道自主画面合成
URI	/api/v1/vc/confs/{conf_id}/mt_channel_vmps
方法	POST
说明	仅端口会议有用，异步操作
最低支持版本	3

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mode*	int	自主画面合成模式 1-定制画面合成； 2-自动画面合成；
layout*	int	画面合成风格: 1-一画面全屏; 2-两画面: 2等大，居中(1行2列); 3-两画面: 1大1小，1大全屏，1小右下; 61-两画面: 1大1小，1大全屏，1小右上; 62-两画面: 1大1小，1大全屏，1小左上; 63-两画面: 1大1小，1大全屏，1小左下; 23-三画面: 等大，1左，2右(2行1列); 4-三画面: 等大，1上2下; 5-四画面: 等大，2行2列; 34-五画面: 1大4小，1大左，4小右(4行1列); 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列); 64-六画面: 1大5小，1大左，2小右(5行1列)，3小下(1行3列); 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列); 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列); 8-九画面: 等大，3行3列; 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列); 38-十一画面: 1大10小，1大上，10小下(2行5列); 65-十一画面: 3大8小，3大上（一行三列），8小下(2行4列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列); 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列); 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列); 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列); 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下（1行6列）; 11-十六画面: 16等分，4x4; 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列); 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列); 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列); 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列); 54-二十一画面: 1大20小，6小上(1行6列)，4小左中(4行1列)，1大中中，4小右中(4行1列)，6小下(1行6列); 56-二十二画面: 1大21小，1大左上，6小右上(2行3列)，15小下(3行5列); 59-二十四画面: 4大20小，6小上(1行6列)，4小左中(4行1列)，4大中中(2行2列)，4小右中(4行1列)，6小下(1行6列)； 27-二十五画面: 等大，5行5列;
mt_id*	str	开启自主画面合成的终端号 最大字符长度：48字节
voice_hint*	int	是否识别声音来源 0-否； 1-是；
show_mt_name*	int	是否显示别名 0-不显示； 1-显示；
mt_chn_idx	int	自主画面合成终端接收的终端通道, 0为自动选择，默认为0
members	array	自主画面合成成员数组
chn_idx*	int	自主画面合成通道索引，从0开始
member_type*	int	成员类型 0-空； 1-会控指定；
mt_id*	str	通道终端号 最大字符长度：48个字节
mt_chn_idx	int	终端通道, 0为自动选择，默认为0

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取终端单通道自主画面合成信息
URI	/api/v1/vc/confs/{conf_id}/mt_channel_vmps/{mt_id}/{mt_chn_idx}
方法	GET
说明	仅端口会议有用，当未开启画面合成时会返回错误，当终端为多流终端时使用
最低支持版本	3

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
mode	int	自主画面合成模式 1-定制画面合成； 2-自动画面合成；
layout	int	画面合成风格: 1-一画面全屏; 2-两画面: 2等大，居中(1行2列); 3-两画面: 1大1小，1大全屏，1小右下; 61-两画面: 1大1小，1大全屏，1小右上; 62-两画面: 1大1小，1大全屏，1小左上; 63-两画面: 1大1小，1大全屏，1小左下; 23-三画面: 等大，1左，2右(2行1列); 4-三画面: 等大，1上2下; 5-四画面: 等大，2行2列; 34-五画面: 1大4小，1大左，4小右(4行1列); 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列); 64-六画面: 1大5小，1大左，2小右(5行1列)，3小下(1行3列); 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列); 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列); 8-九画面: 等大，3行3列; 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列); 38-十一画面: 1大10小，1大上，10小下(2行5列); 65-十一画面: 3大8小，3大上（一行三列），8小下(2行4列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列); 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列); 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列); 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列); 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下（1行6列）; 11-十六画面: 16等分，4x4; 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列); 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列); 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列); 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列); 54-二十一画面: 1大20小，6小上(1行6列)，4小左中(4行1列)，1大中中，4小右中(4行1列)，6小下(1行6列); 56-二十二画面: 1大21小，1大左上，6小右上(2行3列)，15小下(3行5列); 59-二十四画面: 4大20小，6小上(1行6列)，4小左中(4行1列)，4大中中(2行2列)，4小右中(4行1列)，6小下(1行6列)； 27-二十五画面: 等大，5行5列;
voice_hint	int	是否识别声音来源 0-否； 1-是；
show_mt_name	int	是否显示别名 0-不显示； 1-显示；
mt_chn_idx	int	自主画面合成终端接收的终端通道, 0为自动选择，默认为0
members	array	自主画面合成成员数组
chn_idx	int	自主画面合成通道索引，从0开始
member_type	int	成员类型 0-空； 1-会控指定； 2-发言人跟随； 3-管理方跟随； 4-会议轮询跟随； 5-自动语音激励； 6-单通道轮询； 7-双流跟随；
mt_id	str	通道终端号，仅当通道中为会控指定时有效，当成员不在会议中时返回空字符串 最大字符长度：48个字节
mt_chn_idx	int	终端发送的通道, 0为自动选择，默认为0
account	str	成员呼叫别名

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	修改终端单通道自主画面合成参数
URI	/api/v1/vc/confs/{conf_id}/mt_channel_vmps/{mt_id}/{mt_chn_idx}
方法	PUT
说明	仅端口会议有用，异步操作
最低支持版本	3

参数说明

参数名称	数据类型	说明
_method		若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
mode*	int	自主画面合成模式 1-定制画面合成； 2-自动画面合成；
layout*	int	画面合成风格: 1-一画面全屏; 2-两画面: 2等大，居中(1行2列); 3-两画面: 1大1小，1大全屏，1小右下; 61-两画面: 1大1小，1大全屏，1小右上; 62-两画面: 1大1小，1大全屏，1小左上; 63-两画面: 1大1小，1大全屏，1小左下; 23-三画面: 等大，1左，2右(2行1列); 4-三画面: 等大，1上2下; 5-四画面: 等大，2行2列; 34-五画面: 1大4小，1大左，4小右(4行1列); 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列); 64-六画面: 1大5小，1大左，2小右(5行1列)，3小下(1行3列); 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列); 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列); 8-九画面: 等大，3行3列; 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列); 38-十一画面: 1大10小，1大上，10小下(2行5列); 65-十一画面: 3大8小，3大上（一行三列），8小下(2行4列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列); 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列); 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列); 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列); 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下（1行6列）; 11-十六画面: 16等分，4x4; 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列); 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列); 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列); 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列); 54-二十一画面: 1大20小，6小上(1行6列)，4小左中(4行1列)，1大中中，4小右中(4行1列)，6小下(1行6列); 56-二十二画面: 1大21小，1大左上，6小右上(2行3列)，15小下(3行5列); 59-二十四画面: 4大20小，6小上(1行6列)，4小左中(4行1列)，4大中中(2行2列)，4小右中(4行1列)，6小下(1行6列)； 27-二十五画面: 等大，5行5列;
voice_hint*	int	是否识别声音来源 0-否； 1-是；
show_mt_name*	int	是否显示别名 0-不显示； 1-显示；
members	array	自主画面合成成员数组
chn_idx*	int	自主画面合成通道索引，从0开始
member_type*	int	成员类型 0-空； 1-会控指定；
mt_id*	str	通道终端号 最大字符长度：48个字节
mt_chn_idx	int	终端通道, 0为自动选择，默认为0

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	停止终端单通道自主画面合成
URI	/api/v1/vc/confs/{conf_id}/mt_channel_vmps/{mt_id}/{mt_chn_idx}
方法	DELETE
说明	仅端口会议有用，异步操作
最低支持版本	3

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取开启单通道自主画面合成的终端列表
URI	/api/v1/vc/confs/{conf_id}/mt_channel_vmps
方法	GET
说明	获取开启单通道自主画面合成的终端列表，当未开启画面合成时会返回错误
最低支持版本	3

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
mts	array	开启自主画面合成的终端数组
mode	int	自主画面合成模式 1-定制画面合成； 2-自动画面合成；
layout	int	画面合成风格: 1-一画面全屏; 2-两画面: 2等大，居中(1行2列); 3-两画面: 1大1小，1大全屏，1小右下; 61-两画面: 1大1小，1大全屏，1小右上; 62-两画面: 1大1小，1大全屏，1小左上; 63-两画面: 1大1小，1大全屏，1小左下; 23-三画面: 等大，1左，2右(2行1列); 4-三画面: 等大，1上2下; 5-四画面: 等大，2行2列; 34-五画面: 1大4小，1大左，4小右(4行1列); 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列); 64-六画面: 1大5小，1大左，2小右(5行1列)，3小下(1行3列); 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列); 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列); 8-九画面: 等大，3行3列; 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列); 38-十一画面: 1大10小，1大上，10小下(2行5列); 65-十一画面: 3大8小，3大上（一行三列），8小下(2行4列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列); 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列); 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列); 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列); 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下（1行6列）; 11-十六画面: 16等分，4x4; 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列); 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列); 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列); 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列); 54-二十一画面: 1大20小，6小上(1行6列)，4小左中(4行1列)，1大中中，4小右中(4行1列)，6小下(1行6列); 56-二十二画面: 1大21小，1大左上，6小右上(2行3列)，15小下(3行5列); 59-二十四画面: 4大20小，6小上(1行6列)，4小左中(4行1列)，4大中中(2行2列)，4小右中(4行1列)，6小下(1行6列)； 27-二十五画面: 等大，5行5列;
show_mt_name	int	是否显示别名 0-不显示； 1-显示；
voice_hint	int	是否识别声音来源 0-否； 1-是；
mt_id	str	开启自主画面合成的终端号 最大字符长度：48个字节
mt_chn_idx	int	自主画面合成终端接收的终端通道, 0为自动选择，默认为0

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码