科达视讯平台会管API

1. 获取预约会议列表
2. 获取预约会议信息
3. 获取会议列表
4. 获取会议信息
5. 创建会议
6. 结束会议
7. 创建虚拟会议室
8. 修改虚拟会议室
9. 删除虚拟会议室
10. 获取虚拟会议室列表
11. 获取虚拟会议室详情
12. 获取资源占用情况
13. 获取当前用户域可以使用的会议平台
14. 获取会议室区域列表
15. 创建会议室区域
16. 修改会议室区域
17. 删除会议室区域
18. 上传会议文件
19. 删除会议文件
20. 获取会议文件列表
21. 获取会管API版本信息
22. 预约视频会议
23. 更新视频会议
24. 删除预约会议
25. 会议名称校验

名称	获取预约会议列表
URI	/api/v1/mc/booked_confs
方法	GET
说明	获取预约会议列表
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
start	int	默认为0，即从符合条件的数据中的第几行取数据，0为第一行数据
count	int	默认为10，即在包含start在内的后count条数据，如果参数为0表示获取所有
order	int	以预约会议的开始时间为准，默认为0
start_time	str	开始时间，格式为ISO8601:2000标准，不填表示从服务器当前时间开始
end_time	str	结束时间，格式为ISO8601:2000标准，不填表示从开始时间以后的所有

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
total	int	数量
booked_confs	array	预约会议列表
name	str	会议名称 最大字符长度：64个字节
conf_id	str	会议号 最大字符长度：48个字节
meeting_id	str	会议id
conf_type	int	会议类型 0-传统； 1-端口； 2-SFU纯转发会议；
enable_rtc	int	是否允许RTC接入（默认关闭） 0-关闭； 1-开启；
start_time	str	会议开始时间
end_time	str	会议结束时间
duration	int	会议时长,0是永久会议
bitrate	int	会议码率
closed_conf	int	会议免打扰 0-关闭； 1-开启；
safe_conf	int	会议安全 0-公开会议； 1-隐藏会议；
encrypted_type	int	传输加密类型 0-不加密； 2-AES加密； 3-商密（SM4）； 4-商密（SM1）；
encrypted_auth	int	终端双向认证 0-关闭； 1-开启；
password	str	会议密码 最大字符长度：16个字节
mute	int	初始化哑音 0-否； 1-是；
force_mute	int	强制全场哑音 0-否； 1-是；
silence	int	初始化静音 0-否； 1-是；
video_quality	int	视频质量，其中租赁环境默认设为0，自建环境以api下参为准 0-质量优先； 1-速度优先；
one_reforming	int	归一重整 0-不使用； 1-使用；
encrypted_key	str	传输加密AES加密密钥 最大字符长度：16个字节
dual_mode	int	双流权限 0-发言会场； 1-任意会场；
voice_activity_detection	int	是否开启语言激励 0-否； 1-是；
public_conf	int	是否来宾会议室 0-否； 1-是；
invited_mt_num	int	邀请终端数量
max_join_mt	int	最大与会终端数 8-小型8方会议； 32-32方会议； 64-64方会议； 192-大型192方会议；
anonymous_mt	int	是否允许匿名用户免登录，默认为0 0-不允许； 1-允许；
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	错误码
description	str	结果描述

名称	获取预约会议信息
URI	/api/v1/mc/booked_confs/{conf_id}
方法	GET
说明	获取预约会议信息
最低支持版本	1

参数说明

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

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
name	str	会议名称 最大字符长度：64个字节
conf_id	str	会议号 最大字符长度：48个字节
meeting_id	str	会议id
conf_type	int	会议类型 0-传统； 1-端口； 2-SFU纯转发会议；
enable_rtc	int	是否允许RTC接入（默认关闭） 0-关闭； 1-开启；
start_time	str	会议开始时间
end_time	str	会议结束时间
duration	int	会议时长,0是永久会议
bitrate	int	会议码率
closed_conf	int	会议免打扰 0-关闭； 1-开启；
safe_conf	int	会议安全 0-公开会议； 1-隐藏会议；
password	str	会议密码 最大字符长度：16个字节
encrypted_type	int	传输加密类型 0-不加密； 2-AES加密； 3-商密（SM4）； 4-商密（SM1）；
encrypted_auth	int	终端双向认证 0-关闭； 1-开启；
encrypted_key	str	传输加密AES加密密钥 最大字符长度：16个字节
mute	int	初始化哑音 0-否； 1-是；
force_mute	int	强制全场哑音 0-否； 1-是；
mute_filter	int	是否开启全场哑音例外 0-不开启； 1-开启；
fec_mode	int	FEC开关 0-关闭； 1-开启；
silence	int	初始化静音 0-否； 1-是；
video_quality	int	视频质量，其中租赁环境默认设为0，自建环境以api下参为准 0-质量优先； 1-速度优先；
dual_mode	int	双流权限 0-发言会场； 1-任意会场；
doubleflow	int	成为发言人后立即发起内容共享 0-否； 1-是；
voice_activity_detection	int	是否开启语言激励 0-否； 1-是；
vacinterval	int	语音激励敏感度(s),支持3、5、15、30
public_conf	int	是否来宾会议室 0-否； 1-是；
call_times	int	呼叫次数
call_interval	int	呼叫间隔(秒)
cascade_mode	int	级联模式 0-简单级联； 1-合并级联；
cascade_upload	int	是否级联上传 0-否； 1-是；
cascade_return	int	是否级联回传 0-否； 1-是；
cascade_return_para	int	级联回传带宽参数
vmp_enable	int	是否在合成 0-否； 1-是；
mix_enable	int	是否在混音 0-否； 1-是；
poll_enable	int	是否在轮询 0-否； 1-是；
invited_mt_num	int	邀请终端的数量
max_join_mt	int	最大与会终端数 8-小型8方会议； 32-32方会议； 64-64方会议； 192-大型192方会议；
anonymous_mt	int	是否允许匿名用户免登录，默认为0 0-不允许； 1-允许；
multi_stream	int	是否开启多流，默认为0,下级会议里存在多流终端需要回传的场景，需要设1 0-不开启； 1-开启；
sms	int	短信通知 0-关闭； 1-开启；
email	int	邮件通知 0-关闭； 1-开启；
wechat	int	微信通知 0-关闭； 1-开启；
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个字节
speaker	object	发言人
name	str	发言人名称 最大字符长度：128个字节
account	str	帐号 最大字符长度：128个字节
account_type	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
chairman	object	主席
name	str	管理方名称 最大字符长度：128个字节
account	str	帐号 最大字符长度：128个字节
account_type	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
video_formats	array	主视频格式列表
format	int	主视频格式 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+;
resolution	int	主视频分辨率 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k;
frame	int	帧率
bitrate	int	码率
one_reforming	int	归一重整 0-不使用； 1-使用；
auto_end	int	会议中无终端时，是否自动结会 0-否； 1-是；
preoccupy_resource	int	预占资源模式(创会时就预占音视频适配器) 0-不预占模式； 1-预占模式； 2-SFU纯转发模式；

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码
description	str	结果描述

名称	获取会议列表
URI	/api/v1/mc/meetings
方法	GET
说明	获取会议列表
最低支持版本	2

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
start	int	默认为0，即从符合条件的数据中的第几行取数据，0为第一行数据
count	int	默认为10，即在包含start在内的后count条数据，如果参数为0表示获取所有
order	int	以会议的开始时间为准，默认为0
start_time	str	开始时间，格式为ISO8601:2000标准，不填表示从服务器当前时间开始
end_time	str	结束时间，格式为ISO8601:2000标准，不填表示从开始时间以后的所有
state	int	会议状态:1:预约,2:开始,3:结束,6:待审批,7:审批不通过, 不传返回所有

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
total	int	数量
meetings	array	会议列表
name	str	会议名称 最大字符长度：64个字节
conf_id	str	会议号 最大字符长度：48个字节
meeting_id	str	会议id
start_time	str	会议开始时间
end_time	str	会议结束时间
state	int	会议状态 1-预约； 2-开始； 3-结束； 6-待审批； 7-审批不通过；
video	int	是否视频会议 0-否； 1-是；
creator	object	会议发起者
name	str	名称 最大字符长度：128个字节
account	str	帐号 最大字符长度：128个字节
account_type	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号码； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码
description	str	结果描述

名称	获取会议信息
URI	/api/v1/mc/meetings/{meeting_id}
方法	GET
说明	获取会议信息
最低支持版本	2

参数说明

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

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
name	str	会议名称 最大字符长度：64个字节
conf_id	str	会议号 最大字符长度：48个字节
meeting_id	str	会议id
conf_type	int	会议类型 0-传统； 1-端口； 2-SFU纯转发会议；
enable_rtc	int	是否允许RTC接入（默认关闭） 0-关闭； 1-开启；
video_meeting	int	是否视频会议 0-否； 1-是；
state	int	会议状态 1-预约； 2-开始； 3-结束； 6-待审批； 7-审批不通过；
start_time	str	会议开始时间
end_time	str	会议结束时间
duration	int	会议时长,0是永久会议
bitrate	int	会议码率
closed_conf	int	会议免打扰 0-关闭； 1-开启；
safe_conf	int	会议安全 0-公开会议； 1-隐藏会议；
password	str	会议密码 最大字符长度：16个字节
encrypted_type	int	传输加密类型 0-不加密； 2-AES加密； 3-商密（SM4）； 4-商密（SM1）；
encrypted_auth	int	终端双向认证 0-关闭； 1-开启；
encrypted_key	str	传输加密AES加密密钥 最大字符长度：16个字节
mute	int	初始化哑音 0-否； 1-是；
force_mute	int	强制全场哑音 0-否； 1-是；
mute_filter	int	是否开启全场哑音例外 0-不开启； 1-开启；
fec_mode	int	FEC开关 0-关闭； 1-开启；
silence	int	初始化静音 0-否； 1-是；
video_quality	int	视频质量，其中租赁环境默认设为0，自建环境以api下参为准 0-质量优先； 1-速度优先；
dual_mode	int	双流权限 0-发言会场； 1-任意会场；
doubleflow	int	成为发言人后立即发起内容共享 0-否； 1-是；
voice_activity_detection	int	是否开启语言激励 0-否； 1-是；
vacinterval	int	语音激励敏感度(s),支持3、5、15、30
public_conf	int	是否来宾会议室 0-否； 1-是；
call_times	int	呼叫次数
call_interval	int	呼叫间隔(秒)
cascade_mode	int	级联模式 0-简单级联； 1-合并级联；
cascade_upload	int	是否级联上传 0-否； 1-是；
cascade_return	int	是否级联回传 0-否； 1-是；
cascade_return_para	int	级联回传带宽参数
max_join_mt	int	最大与会终端数 8-小型8方会议； 32-32方会议； 64-64方会议； 192-大型192方会议；
anonymous_mt	int	是否允许匿名用户免登录，默认为0 0-不允许； 1-允许；
multi_stream	int	是否开启多流，默认为0,下级会议里存在多流终端需要回传的场景，需要设1 0-不开启； 1-开启；
sms	int	短信通知 0-关闭； 1-开启；
email	int	邮件通知 0-关闭； 1-开启；
wechat	int	微信通知 0-关闭； 1-开启；
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个字节
speaker	object	发言人
name	str	发言人名称 最大字符长度：128个字节
account	str	帐号 最大字符长度：128个字节
account_type	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
chairman	object	主席
name	str	管理方名称 最大字符长度：128个字节
account	str	帐号 最大字符长度：128个字节
account_type	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
video_formats	array	主视频格式列表
format	int	主视频格式 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+;
resolution	int	主视频分辨率 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k;
frame	int	帧率
bitrate	int	码率
one_reforming	int	归一重整 0-不使用； 1-使用；
auto_end	int	会议中无终端时，是否自动结会 0-否； 1-是；
preoccupy_resource	int	预占资源模式(创会时就预占音视频适配器) 0-不预占模式； 1-预占模式； 2-SFU纯转发模式；
members	array	与会人员
name	str	发言人名称 最大字符长度：128个字节
account	str	帐号 最大字符长度：128个字节
account_type	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
rooms	array	会议室
id	int	会议室id
name	str	会议室名称
region_name	str	区域名

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码
description	str	结果描述

名称	创建会议
URI	/api/v1/mc/confs
方法	POST
说明	创建会议,当create_type为1时,必填参数请根据文档;当create_type不为1时,template_id为必填参数,其余参数是非必填参数
最低支持版本	1

参数说明

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

params示例

params说明

参数名称	数据类型	说明
create_type	int	创建会议类型，默认为1 1-及时会议； 2-公共模板； 3-个人模板； 4-根据虚拟会议室创会； 5-预约会议提前召开；
template_id	str	当creat_type不为1时必填，分别对应模板id和虚拟会议室id，当creat_type为5时对应预约会议id
name*	str	会议名称 创建虚拟会议室时可填 1.字符限制：   a.不支持输入特殊字符：% & * ^ ~ ' " " ? / \ < > | ` " $   b.且首字符和尾字符不支持输入，下划线（_） 减号（-） 小数点（.） @ （除首尾字符可以输入） 2.最大字符长度：64个字节
duration*	int	会议时长 创建虚拟会议室时可填，0为永久会议
conf_level	int	会议等级 0—16 数字越大会议等级越高
bitrate*	int	会议码率，目前以主视频格式中的码率为准
closed_conf*	int	会议免打扰 0-关闭； 1-开启；
safe_conf*	int	会议安全 0-公开会议； 1-隐藏会议；
password	str	会议密码 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：16个字节
encrypted_type*	int	传输加密类型 0-不加密； 2-AES加密； 3-商密（SM4）； 4-商密（SM1）；
encrypted_auth	int	终端双向认证，默认为0 0-关闭； 1-开启；
conf_type*	int	会议类型 0:传统会议, 1:端口会议, 2:SFU纯转发会议, 4:auto 自动 自动会议类型规则：   一.终端支持RTC+AVC：    1.平台有端口权限：     - 平台一定支持RTC接入（不包括混用），开端口+RTC混合会议；     - 平台不支持RTC接入或资源混用，开端口会议;    2.平台没有端口权限：     - 平台一定支持RTC接入（不包括混用），开传统+RTC混合会议；     - 平台不支持RTC接入或资源混用，开传统会议;   二.终端只支持AVC：    1.平台有端口权限：     - 平台一定支持RTC接入（不包括混用），开端口+RTC混合会议；     - 平台不支持RTC接入或资源混用，开端口会议;    2.平台没有端口权限：     - 平台一定支持RTC接入（不包括混用），开传统+RTC混合会议；     - 平台不支持RTC接入或资源混用，开传统会议;   三.终端只支持RTC：    1.平台有端口权限：     - 平台支持RTC接入（包括混用），开端口+RTC混合会议；     - 平台不支持RTC接入，支持SFU纯转发会议，开SFU纯转发会议（JD6100-CN场景）；     - 平台不支持RTC接入，不支持SFU纯转发会议，返回错误码;    2.平台没有端口权限：     - 平台支持RTC接入（包括混用），开传统+RTC混合会议；     - 平台不支持RTC接入，支持SFU纯转发会议，开SFU纯转发会议（JD6100-CN场景）；     - 平台不支持RTC接入，不支持SFU纯转发会议，返回错误码;
enable_rtc	int	是否允许RTC接入（默认关闭，和指定会议类型搭配使用，auto自动会议类型下无效）   0:关闭,   1:开启   注意：传统纯转发会议，H265媒体能力，国密（SM1/SM4）和RTC接入不兼容，开启以上能力会关闭RTC接入，无视下参。   指定会议类型为传统/端口：   1.不指定enable_rtc：   -平台一定支持RTC，开混合    -平台不支持RTC或者资源混用，开传统/端口   2.指定enable_rtc为关闭   -开传统/端口   3.指定enable_rtc为开启    -平台支持RTC接入或者资源混用，开混合会议   -平台不支持RTC接入，返回错误码 指定SFU纯转发会议，无视此下参：  1.平台有SFU纯转发会议权限，开SFU纯转发会议  2.平台没有SFU纯转发会议权限，返回错误码
mt_supported_protocol	array	终端支持协议 当conf_type为4时必填 rtc-rtc协议； sip-协议； h323-协议；
call_mode*	int	呼叫模式 0-手动； 2-自动；
call_times*	int	呼叫次数
call_interval*	int	呼叫间隔(秒)
fec_mode	int	FEC开关，默认为0 0-关闭； 1-开启；
mute_filter	int	是否开启全场哑音例外，默认为1 0-不开启； 1-开启；
mute*	int	是否开启初始化哑音 0-否； 1-是；
force_mute*	int	强制全场哑音 0-否； 1-是；
silence*	int	是否开启初始化静音 0-否； 1-是；
video_quality*	int	视频质量,其中租赁环境默认设为速度优先，自建环境默认为质量优先 0-质量优先； 1-速度优先；
encrypted_key*	str	传输加密AES加密密钥 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：16个字节
dual_mode*	int	双流权限 0-发言会场； 1-任意会场；
doubleflow	int	成为发言人后立即发起内容共享，默认为0 0-否； 1-是；
voice_activity_detection*	int	是否开启语音激励 0-否； 1-是；
vacinterval	int	语音激励敏感度(s),支持3、5、15、30
cascade_mode*	int	级联模式 0-简单级联； 1-合并级联；
cascade_upload*	int	是否级联上传 0-否； 1-是；
cascade_return*	int	是否级联回传 0-否； 1-是；
cascade_return_para*	int	级联回传带宽参数
public_conf*	int	是否来宾会议室 0-否； 1-是；
max_join_mt*	int	最大与会终端数 8-小型8方会议； 32-32方会议； 64-64方会议； 192-大型192方会议；
auto_end*	int	会议中无终端时，是否自动结会，永久会议时默认为0 0-否； 1-是；
preoccupy_resource*	int	预占资源模式(创会时就预占音视频适配器) 0-不预占模式； 1-预占模式； 2-SFU纯转发模式；
one_reforming*	int	归一重整 0-不使用； 1-使用；
platform_id	str	创会平台moid，不填则根据用户权限取默认值
anonymous_mt	int	是否允许匿名用户免登录，默认为0 0-不允许； 1-允许；
sms	int	开启短信通知, 默认关闭 0-关闭； 1-开启；
email	int	开启邮件通知, 默认关闭 0-关闭； 1-开启；
wechat	int	开启微信通知, 默认关闭 0-关闭； 1-开启；
multi_stream	int	是否开启多流，默认为0,下级会议里存在多流终端需要回传的场景，需要设1 0-不开启； 1-开启；
speaker	object	发言人
name*	str	发言人名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
chairman	object	主席
name*	str	管理方名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
mix	object	混音信息
mode*	int	混音模式 1-智能混音； 2-定制混音；
members*	array	制定混音时的混音成员列表
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
video_formats*	array	主视频格式列表
format*	int	主视频格式 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+;
resolution*	int	主视频分辨率 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k;
frame*	int	帧率
bitrate*	int	码率
invite_members	array	参会成员 创建虚拟会议室时可填
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
bitrate*	int	终端呼叫码率，不可超过会议码率，默认为会议码率
protocol*	int	呼叫协议 0-H323； 1-SIP； 2-rtc；
audio_formats	array	音频格式列表 不填默认支持所有，空列表默认支持所有 1-G.722； 2-G711(ULAW)； 3-G.711(ALAW)； 4-G.729； 5-G.728； 6-G722.1.C； 7-MP3； 8-G.719； 9-MPEG-4 AAC LC； 10-MPEG-4 AAC LD； 11-MPEG-4 AAC LC(stereo)； 12-MPEG-4 AAC LD(stereo)； 13-OPUS；
keep_calling_members	array	追呼成员数组
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
vmp	object	画面合成设置
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列; 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行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列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 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列); 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列;
except_self*	int	是否开启自动画面合成n-1模式, 即不显示自己的画面, 仅自动画面合成时有效,默认为0 0-否； 1-是；
voice_hint*	int	是否识别声音来源 0-否； 1-是；
broadcast*	int	是否向终端广播 0-否； 1-是；
show_mt_name*	int	是否显示别名 0-否； 1-是；
mt_name_style	object	画面合成参数
font_size*	int	台标字体大小，默认为：1 0-小； 1-中； 2-大；
font_color*	str	台标字体三原色#RGB格式，十六进制表示，默认为：#FFFFFF白色
position*	int	台标显示位置，默认为1 0-左上角； 1-左下角； 2-右上角； 3-右下角； 4-底部中间；
members*	array	画面合成成员列表
name*	str	名称 最大字符长度：128个字节 仅当跟随类型为会控指定时才需要输入
account*	str	帐号 最大字符长度：128个字节 仅当跟随类型为会控指定时才需要输入
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
member_type*	int	跟随类型 1-会控指定； 2-发言人跟随； 3-管理方跟随； 4-会议轮询跟随； 6-单通道轮询； 7-内容共享跟随；
chn_idx*	int	在画画合成中的位置
poll	object	单通道轮询设置
mode*	int	轮询模式 1-视频轮询； 3-音视频轮询；
num*	int	轮询次数，0无限次轮询
keep_time*	int	轮询间隔时间(秒)
members*	array	轮询成员列表
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
vips	array	vip成员列表
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
poll	object	轮询设置
mode*	int	轮询模式 1-视频轮询； 3-音视频轮询；
num*	int	轮询次数，0无限次轮询
keep_time*	int	轮询间隔时间(秒)
members*	array	轮询成员列表
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
recorder	object	录像设置
publish_mode*	int	发布模式 0-不发布； 1-发布；
dual_stream*	int	是否内容共享录像 0-否； 1-是；
anonymous*	int	是否支持免登陆观看直播 0-不支持； 1-支持；
recorder_mode*	int	录像模式 0-未开启录像和直播； 1-录像； 2-直播； 3-录像+直播；
vrs_id	str	VRS的moid
dcs	object	数据协作
mode*	int	数据协作模式 0-关闭数据协作； 1-管理方控制； 2-自由协作；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
conf_id	str	会议号码
meeting_id	str	视频会议唯一id
description	str	结果描述

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	结束会议
URI	/api/v1/mc/confs/{conf_id}
方法	DELETE
说明	结束会议
最低支持版本	1

参数说明

参数名称	数据类型	说明
_method		若不支持DELETE，则使用POST请求，并在请求带上_method参数，值为DELETE
account_token*	str	软件权限token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
description	str	结果描述

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	创建虚拟会议室
URI	/api/v1/mc/virtual_meeting_rooms
方法	POST
说明	创建虚拟会议室，参数中非必填项默认值为0
最低支持版本	1

参数说明

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

params示例

params说明

参数名称	数据类型	说明
name*	str	虚拟会议室名称 1.字符限制：   a.不支持输入特殊字符：% & * ^ ~ ' " " ? / \ < > | ` " $   b.且首字符和尾字符不支持输入，下划线（_） 减号（-） 小数点（.） @ （除首尾字符可以输入） 2.最大字符长度：64个字节
bitrate	int	会议码率，目前以主视频格式中的码率为准
video_formats*	array	主视频格式列表
format*	int	主视频格式 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+;
resolution*	int	主视频分辨率 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k;
frame*	int	帧率
bitrate*	int	码率
audio_formats	array	音频格式列表 不填默认支持所有，空列表默认支持所有 1-G.722； 2-G711(ULAW)； 3-G.711(ALAW)； 4-G.729； 5-G.728； 6-G722.1.C； 7-MP3； 8-G.719； 9-MPEG-4 AAC LC； 10-MPEG-4 AAC LD； 11-MPEG-4 AAC LC(stereo)； 12-MPEG-4 AAC LD(stereo)； 13-OPUS；
conf_type	int	会议类型 0-传统会议； 1-端口媒体会议； 2-SFU纯转发会议；
enable_rtc	int	是否允许RTC接入（默认关闭） 0-关闭； 1-开启；
max_join_mt*	int	最大与会终端数 8-8方视频会议； 32-32方视频会议； 64-64方视频会议； 192-192方视频会议；
cascade_mode	int	级联模式 0-简单级联； 1-合并级联；
cascade_upload	int	是否级联上传 0-否； 1-是；
cascade_return	int	是否级联回传 0-否； 1-是；
cascade_return_para	int	级联回传带宽参数
mute	int	是否开启初始化哑音 0-否； 1-是；
force_mute*	int	强制全场哑音 0-否； 1-是；
mute_filter	int	是否开启全场哑音例外 0-不开启； 1-开启；
mix	object	混音信息
mode*	int	混音模式 1-智能混音；
vmp	object	画面合成设置
mode*	int	画面合成模式 2-自动画面合成；
recorder	object	录像设置
publish_mode*	int	是否发布到视频点播 0-否； 1-是；
dual_stream*	int	是否内容共享录像 0-否； 1-是；
anonymous*	int	是否支持免登陆观看直播 0-不支持； 1-支持；
recorder_mode*	int	录像模式 0-未开启录像或直播； 1-录像； 2-直播； 3-录像+直播；
vrs_id	str	VRS的moid
preoccupy_resource*	int	预占资源模式(创会时就预占音视频适配器) 0-不预占模式； 1-预占模式； 2-SFU纯转发模式；
encrypted_type	int	传输加密类型 0-不加密； 2-AES加密； 3-商密（SM4）； 4-商密（SM1）；
encrypted_auth	int	终端双向认证 0-关闭； 1-开启；
encrypted_key	str	传输加密AES加密密钥 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：16个字节
dual_mode	int	内容共享权限／双流权限 1-任意会场； 0-发言会场；
call_mode	int	呼叫模式 0-手动； 2-自动；
call_times	int	呼叫次数
call_interval	int	呼叫间隔(秒)
voice_activity_detection	int	是否开启语音激励 0-否； 1-是；
vacinterval	int	语音激励敏感度(s),支持3、5、15、30
one_reforming	int	归一重整
fec_mode	int	FEC开关 0-关闭； 1-开启；
exclusive	int	是否是专属虚拟会议室 0-否； 1-是；
anonymous_mt	int	是否允许匿名用户免登录，默认为0 0-不允许； 1-允许；
multi_stream	int	是否开启多流，默认为0,下级会议里存在多流终端需要回传的场景，需要设1 0-不开启； 1-开启；
public_conf	int	是否来宾会议室，若账号是来宾用户，则只能查看来宾会议室，默认为0 0-否； 1-是；
exclusive_users	array	专属人员列表
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
name*	str	名称 最大字符长度：128个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
id	str	虚拟会议室id
description	str	结果描述

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	修改虚拟会议室
URI	/api/v1/mc/virtual_meeting_rooms/{id}
方法	POST
说明	修改虚拟会议室，参数中非必填项默认值为0
最低支持版本	1

参数说明

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

params示例

params说明

参数名称	数据类型	说明
name*	str	虚拟会议室名称 1.字符限制：   a.不支持输入特殊字符：% & * ^ ~ ' " " ? / \ < > | ` " $   b.且首字符和尾字符不支持输入，下划线（_） 减号（-） 小数点（.） @ （除首尾字符可以输入） 2.最大字符长度：64个字节
bitrate	int	会议码率，目前以主视频格式中的码率为准
video_formats*	array	主视频格式列表
format*	int	主视频格式 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+;
resolution*	int	主视频分辨率 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k;
frame*	int	帧率
bitrate*	int	码率
audio_formats	array	音频格式列表 不填默认支持所有，空列表默认支持所有 1-G.722； 2-G711(ULAW)； 3-G.711(ALAW)； 4-G.729； 5-G.728； 6-G722.1.C； 7-MP3； 8-G.719； 9-MPEG-4 AAC LC； 10-MPEG-4 AAC LD； 11-MPEG-4 AAC LC(stereo)； 12-MPEG-4 AAC LD(stereo)； 13-OPUS；
conf_type	int	会议类型 0-传统会议； 1-端口媒体会议； 2-SFU纯转发会议；
enable_rtc	int	是否允许RTC接入（默认关闭） 0-关闭； 1-开启；
status	int	会议状态 0-空闲； 1-使用中；
max_join_mt*	int	最大与会终端数 8-8方视频会议； 32-32方视频会议； 64-64方视频会议； 192-192方视频会议；
cascade_mode	int	级联模式 0-简单级联； 1-合并级联；
cascade_upload	int	是否级联上传 0-否； 1-是；
cascade_return	int	是否级联回传 0-否； 1-是；
cascade_return_para	int	级联回传带宽参数
mute	int	是否开启初始化哑音 0-否； 1-是；
force_mute*	int	强制全场哑音 0-否； 1-是；
mute_filter	int	是否开启全场哑音例外 0-不开启； 1-开启；
mix	object	混音信息
mode*	int	混音模式 1-智能混音；
vmp	object	画面合成设置
mode*	int	画面合成模式 2-自动画面合成；
recorder	object	录像设置
publish_mode*	int	是否发布到视频点播 0-否； 1-是；
dual_stream*	int	是否内容共享录像 0-否； 1-是；
anonymous*	int	是否支持免登陆观看直播 0-不支持； 1-支持；
recorder_mode*	int	录像模式 0-未开启录像或直播； 1-录像； 2-直播； 3-录像+直播；
vrs_id	str	VRS的moid
preoccupy_resource*	int	预占资源模式(创会时就预占音视频适配器) 0-不预占模式； 1-预占模式； 2-SFU纯转发模式；
encrypted_type	int	传输加密类型 0-不加密； 2-AES加密； 3-商密（SM4）； 4-商密（SM1）；
encrypted_auth	int	终端双向认证 0-关闭； 1-开启；
encrypted_key	str	传输加密AES加密密钥 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：16个字节
dual_mode	int	内容共享权限／双流权限 1-任意会场； 0-发言会场；
call_mode	int	呼叫模式 0-手动； 2-自动；
call_times	int	呼叫次数
call_interval	int	呼叫间隔(秒)
voice_activity_detection	int	是否开启语音激励 0-否； 1-是；
vacinterval	int	语音激励敏感度(s),支持3、5、15、30
one_reforming	int	归一重整
fec_mode	int	FEC开关 0-关闭； 1-开启；
exclusive	int	是否是专属虚拟会议室 0-否； 1-是；
anonymous_mt	int	是否允许匿名用户免登录，默认为0 0-不允许； 1-允许；
multi_stream	int	是否开启多流，默认为0,下级会议里存在多流终端需要回传的场景，需要设1 0-不开启； 1-开启；
public_conf	int	是否来宾会议室，若账号是来宾用户，则只能查看来宾会议室，默认为0 0-否； 1-是；
exclusive_users	array	专属人员列表
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
name*	str	名称 最大字符长度：128个字节

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
description	str	结果描述

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	删除虚拟会议室
URI	/api/v1/mc/virtual_meeting_rooms/{id}
方法	DELETE
说明	删除虚拟会议室
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	通过oauth登录获取到的授权码
_method		若浏览器不支持DELETE，则使用POST请求，并在请求参数中带上_method参数，并设置其值为DELETE，作为不支持DELETE请求的替代方案。

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	表示操作成功或失败
description	str	描述

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	表示操作成功或失败
error_code	int	失败时的错误号
description	str	结果描述

名称	获取虚拟会议室列表
URI	/api/v1/mc/virtual_meeting_rooms
方法	GET
说明	获取虚拟会议室列表
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	认证token
count	int	获取的虚拟会议数，默认为10，即在包含start在内的后count条数据，如果参数为0表示获取所有虚拟会议室
order	int	根据虚拟会议的时间排序，默认为0 0-升序； 1-降序；
start	int	虚拟会议的开始行，默认为0，即从符合条件的数据中的第几行取数据，0为第一行数据

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
total	int	总数
virtual_meeting_rooms	array	虚拟会议数组
id	str	虚拟会议室id
name	str	虚拟会议室名称 最大字符长度：64个字符
bitrate	int	会议码率
exclusive	int	是否是专属会议室 0-否； 1-是；
exclusive_users	array	专属人员列表
account	str	帐号 最大字符长度：128个字节
account_type	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
name	str	名称 最大字符长度：128个字节
e164	str	虚拟会议号码
conf_name	str	会议主题，针对使用中的虚拟会议室，如果空闲则为空
status	int	会议状态 0-空闲； 1-使用中；
max_join_mt	int	最大与会终端数 8-8方视频会议； 32-32方视频会议； 64-64方视频会议； 192-192方视频会议；
resolution	int	视频分辨率 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k;
encrypted_key	str	传输加密AES加密密钥,仅AES加密时返回 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：16个字节
conf_type	int	会议类型 0-传统会议； 1-端口媒体会议； 2-SFU纯转发会议；
enable_rtc	int	是否允许RTC接入（默认关闭） 0-关闭； 1-开启；

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码
description	str	结果描述

名称	获取虚拟会议室详情
URI	/api/v1/mc/virtual_meeting_rooms/{id}
方法	GET
说明	获取虚拟会议室详情
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	认证token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
name	str	虚拟会议室名称 1.字符限制：   a.不支持输入特殊字符：% & * ^ ~ ' " " ? / \ < > | ` " $   b.且首字符和尾字符不支持输入，下划线（_） 减号（-） 小数点（.） @ （除首尾字符可以输入） 2.最大字符长度：64个字节
e164	str	虚拟会议号码
bitrate	int	会议码率，目前以主视频格式中的码率为准
video_formats	array	主视频格式列表
format	int	主视频格式 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+;
resolution	int	主视频分辨率 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k;
frame	int	帧率
bitrate	int	码率
audio_formats	array	音频格式列表 若返回空列表则默认支持所有格式 1-G.722； 2-G711(ULAW)； 3-G.711(ALAW)； 4-G.729； 5-G.728； 6-G722.1.C； 7-MP3； 8-G.719； 9-MPEG-4 AAC LC； 10-MPEG-4 AAC LD； 11-MPEG-4 AAC LC(stereo)； 12-MPEG-4 AAC LD(stereo)； 13-OPUS；
conf_name	str	会议名称，针对使用中的虚拟会议室，如果空闲则为空
conf_type	int	会议类型 0-传统会议； 1-端口媒体会议； 2-SFU纯转发会议；
enable_rtc	int	是否允许RTC接入（默认关闭） 0-关闭； 1-开启；
status	int	会议状态 0-空闲； 1-使用中；
max_join_mt	int	最大与会终端数 8-8方视频会议； 32-32方视频会议； 64-64方视频会议； 192-192方视频会议；
cascade_mode	int	级联模式 0-简单级联； 1-合并级联；
cascade_upload	int	是否级联上传 0-否； 1-是；
cascade_return	int	是否级联回传 0-否； 1-是；
cascade_return_para	int	级联回传带宽参数
mute	int	是否开启初始化哑音 0-否； 1-是；
force_mute	int	强制全场哑音 0-否； 1-是；
mute_filter	int	是否开启全场哑音例外 0-不开启； 1-开启；
mix	object	混音信息
mode	int	混音模式 1-智能混音；
vmp	object	画面合成设置
mode	int	画面合成模式 2-自动画面合成；
recorder	object	录像设置
publish_mode	int	是否发布到视频点播 0-否； 1-是；
dual_stream	int	是否内容共享录像 0-否； 1-是；
anonymous	int	是否支持免登陆观看直播 0-不支持； 1-支持；
recorder_mode	int	录像模式 0-未开启录像或直播； 1-录像； 2-直播； 3-录像+直播；
vrs_id	str	VRS的moid
preoccupy_resource	int	预占资源模式(创会时就预占音视频适配器) 0-不预占模式； 1-预占模式； 2-SFU纯转发模式；
encrypted_type	int	传输加密类型 0-不加密； 2-AES加密； 3-商密（SM4）； 4-商密（SM1）；
encrypted_auth	int	终端双向认证 0-关闭； 1-开启；
encrypted_key	str	传输加密AES加密密钥,仅AES加密时返回 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：16个字节
dual_mode	int	内容共享权限／双流权限 1-任意会场； 0-发言会场；
call_mode	int	呼叫模式 0-手动； 2-自动；
call_times	int	呼叫次数
call_interval	int	呼叫间隔(秒)
voice_activity_detection	int	是否开启语音激励 0-否； 1-是；
vacinterval	int	语音激励敏感度(s),支持3、5、15、30
one_reforming	int	归一重整
fec_mode	int	FEC开关 0-关闭； 1-开启；
exclusive	int	是否是专属虚拟会议室 0-否； 1-是；
anonymous_mt	int	是否允许匿名用户免登录，默认为0 0-不允许； 1-允许；
multi_stream	int	是否开启多流，默认为0,下级会议里存在多流终端需要回传的场景，需要设1 0-不开启； 1-开启；
public_conf	int	是否来宾会议室，若账号是来宾用户，则只能查看来宾会议室，默认为0 0-否； 1-是；
exclusive_users	array	专属人员列表
account	str	帐号 最大字符长度：128个字节
account_type	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
name	str	名称 最大字符长度：128个字节

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码
description	str	结果描述

名称	获取资源占用情况
URI	/api/v1/mc/resources
方法	GET
说明	获取资源占用情况
最低支持版本	1

参数说明

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

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
resource_type	int	资源类型 1-仅限制方数； 2-同时限制方数及分辨率；
resources	array	资源列表
name	str	名称： resource_type=1 时返回限制方数 如：大型会议/小型会议 resource_type=2 返回方数和分辨率 如：8方720P/32方1080P等
resolution	int	主视频分辨率,仅resource_type=2才会返回 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k;
max_join_mt	int	最大与会终端数 8-8方视频会议； 32-32方视频会议； 64-64方视频会议； 192-192方视频会议；
total	int	资源总数 最大字符长度：8个字节
used	int	资源已占用数

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码
description	str	结果描述

名称	获取当前用户域可以使用的会议平台
URI	/api/v1/mc/platforms
方法	GET
说明	获取当前用户域可以使用的会议平台
最低支持版本	1

参数说明

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

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
platforms	array	资源列表
name	str	名称
platform_id	str	平台moid
type	int	公有云私有云类型 1-私有云； 2-公有云；

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码
description	str	结果描述

名称	获取会议室区域列表
URI	/api/v1/mc/meeting_room_areas
方法	GET
说明	获取会议室区域列表
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	认证token
count	int	获取会议室区域数量，默认为10，即在包含start在内的后count条数据，如果参数为0表示获取所有数据
order	int	保留
start	int	会议室区域开始行，默认为0，即从符合条件的数据中的第几行取数据，0为第一行数据

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
total	int	总数
meeting_room_areas	array	会议室区域数组
id	str	会议室区域id
area	str	会议室区域名称 最大字符长度：60个字符

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码
description	str	结果描述

名称	创建会议室区域
URI	/api/v1/mc/meeting_room_areas
方法	POST
说明	创建会议室区域,管理员有权限
最低支持版本	1

参数说明

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

params示例

params说明

参数名称	数据类型	说明
area*	str	会议室区域名称 1.最大字符长度：60个字符

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
id	str	会议室区域id
description	str	结果描述

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	修改会议室区域
URI	/api/v1/mc/meeting_room_areas/{id}
方法	POST
说明	修改会议室区域,管理员有权限
最低支持版本	1

参数说明

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

params示例

params说明

参数名称	数据类型	说明
area*	str	会议室区域名称 1.最大字符长度：60个字符

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
description	str	结果描述

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	删除会议室区域
URI	/api/v1/mc/meeting_room_areas/{id}
方法	DELETE
说明	删除会议室区域，管理员有权限
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	认证token
_method		若浏览器不支持DELETE，则使用POST请求，并在请求参数中带上_method参数，并设置其值为DELETE，作为不支持DELETE请求的替代方案。

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
description	str	结果描述

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	上传会议文件
URI	/api/v1/mc/meeting_files/{meeting_id}
方法	POST
说明	上传会议文件，一次只能上传一个文件，每个文件不超过20MB，一个会议最多保存10个文件
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	认证token
file*	File	文件，该参数需要配合request的content-type改为multipart/form-data一起使用

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
description	str	结果描述
meeting_file	object	上传的文件信息
file_id	str	文件id
meeting_id	str	会议id
file_name	str	文件名
file_type	str	文件类型 1-txt; 2-doc; 3-docx; 4-xls; 5-xlsx; 6-ppt; 7-pptx; 8-pdf; 9-rar; 10-zip; 11-jpg; 12-png; 13-bmp;
extension_name	str	文件扩展名
file_url	str	文件相对路径
file_size	str	文件大小，单位是M
creator_moid	str	上传者moid
creator_name	str	上传者姓名
create_time	str	上传时间

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	删除会议文件
URI	/api/v1/mc/meeting_files/{file_id}
方法	DELETE
说明	删除会议文件
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	认证token
_method		若浏览器不支持DELETE，则使用POST请求，并在请求参数中带上_method参数，并设置其值为DELETE，作为不支持DELETE请求的替代方案。

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
description	str	结果描述

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	获取会议文件列表
URI	/api/v1/mc/meeting_files/{meeting_id}
方法	GET
说明	获取会议文件列表，meeting_id是会议id,文件7天后自动删除,
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	认证token

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
total	int	总数
meeting_files	array	会议文件数组
file_id	str	文件id
meeting_id	str	会议id
file_name	str	文件名
file_type	str	文件类型 1-txt； 2-doc； 3-docx； 4-xls； 5-xlsx； 6-ppt； 7-pptx； 8-pdf； 9-rar； 10-zip； 11-jpg； 12-png； 13-bmp；
extension_name	str	文件扩展名
file_url	str	文件相对路径
file_size	str	文件大小，单位是M
creator_moid	str	上传者moid
creator_name	str	上传者姓名
create_time	str	上传时间

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码
description	str	结果描述

名称	获取会管API版本信息
URI	/api/mc/version
方法	GET
说明	获取会管API版本信息
最低支持版本	1

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
version	str	版本信息
api_level	int	会管API版本标识，请与会管API说明文档中的各个接口的最低支持版本号作对比，若小于最低支持版本号，则该接口不支持当前版本的API调用

失败回复示例

失败回复说明

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

名称	预约视频会议
URI	/api/v1/mc/booked_confs
方法	POST
说明	预约视频会议
最低支持版本	3

参数说明

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

params示例

params说明

参数名称	数据类型	说明
name*	str	会议名称 创建虚拟会议室时可填 1.字符限制：   a.不支持输入特殊字符：% & * ^ ~ ' " " ? / \ < > | ` " $   b.且首字符和尾字符不支持输入，下划线（_） 减号（-） 小数点（.） @ （除首尾字符可以输入） 2.最大字符长度：64个字节
start_time*	str	会议开始时间，格式为ISO8601:2000标准
duration*	int	会议时长 创建虚拟会议室时可填，0为永久会议
bitrate*	int	会议码率，目前以主视频格式中的码率为准
closed_conf*	int	会议免打扰 0-关闭； 1-开启；
safe_conf*	int	会议安全 0-公开会议； 1-隐藏会议；
password	str	会议密码 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：16个字节
encrypted_type*	int	传输加密类型 0-不加密； 2-AES加密； 3-商密（SM4）； 4-商密（SM1）；
encrypted_auth	int	终端双向认证，默认为0 0-关闭； 1-开启；
conf_type*	int	会议类型 0-传统会议； 1-端口会议； 2-SFU纯转发会议； 4-auto；
enable_rtc	int	是否允许RTC接入（默认关闭） 0-关闭； 1-开启；
mt_supported_protocol	array	终端支持协议 当conf_type为4时必填 rtc-rtc协议； sip-协议； h323-协议；
call_mode*	int	呼叫模式 0-手动； 2-自动；
call_times*	int	呼叫次数
call_interval*	int	呼叫间隔(秒)
call_chase	int	是否追呼，默认追呼
fec_mode	int	FEC开关，默认为0 0-关闭； 1-开启；
mute_filter	int	是否开启全场哑音例外，默认为1 0-不开启； 1-开启；
mute*	int	是否开启初始化哑音 0-否； 1-是；
force_mute*	int	强制全场哑音 0-否； 1-是；
silence*	int	是否开启初始化静音 0-否； 1-是；
video_quality*	int	视频质量,其中租赁环境默认设为速度优先，自建环境默认为质量优先 0-质量优先； 1-速度优先；
encrypted_key*	str	传输加密AES加密密钥 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：16个字节
dual_mode*	int	双流权限 0-发言会场； 1-任意会场；
doubleflow	int	成为发言人后立即发起内容共享，默认为0 0-否； 1-是；
voice_activity_detection*	int	是否开启语音激励 0-否； 1-是；
vacinterval	int	语音激励敏感度(s),支持3、5、15、30
cascade_mode*	int	级联模式 0-简单级联； 1-合并级联；
cascade_upload*	int	是否级联上传 0-否； 1-是；
cascade_return*	int	是否级联回传 0-否； 1-是；
cascade_return_para*	int	级联回传带宽参数
public_conf*	int	是否来宾会议室 0-否； 1-是；
max_join_mt*	int	最大与会终端数 8-小型8方会议； 32-32方会议； 64-64方会议； 192-大型192方会议；
auto_end*	int	会议中无终端时，是否自动结会，永久会议时默认为0 0-否； 1-是；
preoccupy_resource*	int	预占资源模式(创会时就预占音视频适配器) 0-不预占模式； 1-预占模式； 2-SFU纯转发模式；
one_reforming*	int	归一重整 0-不使用； 1-使用；
platform_id	str	创会平台moid，不填则根据用户权限取默认值
anonymous_mt	int	是否允许匿名用户免登录，默认为0 0-不允许； 1-允许；
multi_stream	int	是否开启多流，默认为0,下级会议里存在多流终端需要回传的场景，需要设1 0-不开启； 1-开启；
sms	int	开启短信通知, 默认关闭 0-关闭； 1-开启；
email	int	开启邮件通知, 默认关闭 0-关闭； 1-开启；
wechat	int	开启微信通知, 默认关闭 0-关闭； 1-开启；
speaker	object	发言人
name*	str	发言人名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
chairman	object	主席
name*	str	管理方名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
mix	object	混音信息
mode*	int	混音模式 1-智能混音； 2-定制混音；
members*	array	制定混音时的混音成员列表
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
video_formats*	array	主视频格式列表
format*	int	主视频格式 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+;
resolution*	int	主视频分辨率 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k;
frame*	int	帧率
bitrate*	int	码率
invite_members	array	参会成员 创建虚拟会议室时可填
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
bitrate*	int	终端呼叫码率，不可超过会议码率，默认为会议码率
protocol*	int	呼叫协议 0-H323； 1-SIP； 2-rtc；
audio_formats	array	音频格式列表 不填默认支持所有，空列表默认支持所有 1-G.722； 2-G711(ULAW)； 3-G.711(ALAW)； 4-G.729； 5-G.728； 6-G722.1.C； 7-MP3； 8-G.719； 9-MPEG-4 AAC LC； 10-MPEG-4 AAC LD； 11-MPEG-4 AAC LC(stereo)； 12-MPEG-4 AAC LD(stereo)； 13-OPUS；
keep_calling_members	array	追呼成员数组
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
vmp	object	画面合成设置
mode*	int	画面合成模式 1-定制画面合成； 2-自动画面合成；
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列; 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行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列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 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列); 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-是；
broadcast*	int	是否向终端广播 0-否； 1-是；
show_mt_name*	int	是否显示别名 0-否； 1-是；
mt_name_style	object	画面合成参数
font_size*	int	台标字体大小，默认为：1 0-小； 1-中； 2-大；
font_color*	str	台标字体三原色#RGB格式，十六进制表示，默认为：#FFFFFF白色
position*	int	台标显示位置，默认为1 0-左上角； 1-左下角； 2-右上角； 3-右下角； 4-底部中间；
members*	array	画面合成成员列表
name*	str	名称 最大字符长度：128个字节 仅当跟随类型为会控指定时才需要输入
account*	str	帐号 最大字符长度：128个字节 仅当跟随类型为会控指定时才需要输入
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
member_type*	int	跟随类型 1-会控指定； 2-发言人跟随； 3-管理方跟随； 4-会议轮询跟随； 6-单通道轮询； 7-内容共享跟随；
chn_idx*	int	在画画合成中的位置
poll	object	单通道轮询设置
mode*	int	轮询模式 1-视频轮询； 3-音视频轮询；
num*	int	轮询次数，0无限次轮询
keep_time*	int	轮询间隔时间(秒)
members*	array	轮询成员列表
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
vips	array	vip成员列表
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
poll	object	轮询设置
mode*	int	轮询模式 1-视频轮询； 3-音视频轮询；
num*	int	轮询次数，0无限次轮询
keep_time*	int	轮询间隔时间(秒)
members*	array	轮询成员列表
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
recorder	object	录像设置
publish_mode*	int	发布模式 0-不发布； 1-发布；
dual_stream*	int	是否内容共享录像 0-否； 1-是；
anonymous*	int	是否支持免登陆观看直播 0-不支持； 1-支持；
recorder_mode*	int	录像模式 1-录像； 2-直播； 3-录像+直播；
vrs_id	str	VRS的moid
dcs	object	数据协作
mode*	int	数据协作模式 0-关闭数据协作； 1-管理方控制； 2-自由协作；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
conf_id	str	会议号码
meeting_id	str	视频会议唯一id
description	str	结果描述

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	更新视频会议
URI	/api/v1/mc/booked_confs/{conf_id}
方法	POST
说明	更新视频会议
最低支持版本	3

参数说明

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

params示例

params说明

参数名称	数据类型	说明
name*	str	会议名称 1.字符限制：   a.不支持输入特殊字符：% & * ^ ~ ' " " ? / \ < > | ` " $   b.且首字符和尾字符不支持输入，下划线（_） 减号（-） 小数点（.） @ （除首尾字符可以输入） 2.最大字符长度：64个字节
start_time*	str	会议开始时间，格式为ISO8601:2000标准
duration*	int	会议时长 创建虚拟会议室时可填，0为永久会议
bitrate*	int	会议码率，目前以主视频格式中的码率为准
closed_conf*	int	会议免打扰 0-关闭； 1-开启；
safe_conf*	int	会议安全 0-公开会议； 1-隐藏会议；
password	str	会议密码 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：16个字节
encrypted_type*	int	传输加密类型 0-不加密； 2-AES加密； 3-商密（SM4）； 4-商密（SM1）；
encrypted_auth	int	终端双向认证，默认为0 0-关闭； 1-开启；
conf_type*	int	会议类型 0-传统会议； 1-端口会议； 2-SFU纯转发会议； 4-auto；
enable_rtc	int	是否允许RTC接入（默认关闭） 0-关闭； 1-开启；
mt_supported_protocol	array	终端支持协议 当conf_type为4时必填 rtc-rtc协议； sip-协议； h323-协议；
call_mode*	int	呼叫模式 0-手动； 2-自动；
call_times*	int	呼叫次数
call_interval*	int	呼叫间隔(秒)
call_chase	int	是否追呼，默认追呼
fec_mode	int	FEC开关，默认为0 0-关闭； 1-开启；
mute_filter	int	是否开启全场哑音例外，默认为1 0-不开启； 1-开启；
mute*	int	是否开启初始化哑音 0-否； 1-是；
force_mute*	int	强制全场哑音 0-否； 1-是；
silence*	int	是否开启初始化静音 0-否； 1-是；
video_quality*	int	视频质量,其中租赁环境默认设为速度优先，自建环境默认为质量优先 0-质量优先； 1-速度优先；
encrypted_key*	str	传输加密AES加密密钥 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：16个字节
dual_mode*	int	双流权限 0-发言会场； 1-任意会场；
doubleflow	int	成为发言人后立即发起内容共享，默认为0 0-否； 1-是；
voice_activity_detection*	int	是否开启语音激励 0-否； 1-是；
vacinterval	int	语音激励敏感度(s),,支持3、5、15、30
cascade_mode*	int	级联模式 0-简单级联； 1-合并级联；
cascade_upload*	int	是否级联上传 0-否； 1-是；
cascade_return*	int	是否级联回传 0-否； 1-是；
cascade_return_para*	int	级联回传带宽参数
public_conf*	int	是否来宾会议室 0-否； 1-是；
max_join_mt*	int	最大与会终端数 8-小型8方会议； 32-32方会议； 64-64方会议； 192-大型192方会议；
auto_end*	int	会议中无终端时，是否自动结会，永久会议时默认为0 0-否； 1-是；
preoccupy_resource*	int	预占资源模式(创会时就预占音视频适配器) 0-不预占模式； 1-预占模式； 2-SFU纯转发模式；
one_reforming*	int	归一重整 0-不使用； 1-使用；
platform_id	str	创会平台moid，不填则根据用户权限取默认值
anonymous_mt	int	是否允许匿名用户免登录，默认为0 0-不允许； 1-允许；
multi_stream	int	是否开启多流，默认为0,下级会议里存在多流终端需要回传的场景，需要设1 0-不开启； 1-开启；
sms	int	开启短信通知, 默认关闭 0-关闭； 1-开启；
email	int	开启邮件通知, 默认关闭 0-关闭； 1-开启；
wechat	int	开启微信通知, 默认关闭 0-关闭； 1-开启；
speaker	object	发言人
name*	str	发言人名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
chairman	object	主席
name*	str	管理方名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
mix	object	混音信息
mode*	int	混音模式 1-智能混音； 2-定制混音；
members*	array	制定混音时的混音成员列表
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
video_formats*	array	主视频格式列表
format*	int	主视频格式 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+;
resolution*	int	主视频分辨率 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k;
frame*	int	帧率
bitrate*	int	码率
invite_members	array	参会成员 创建虚拟会议室时可填
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
bitrate*	int	终端呼叫码率，不可超过会议码率，默认为会议码率
protocol*	int	呼叫协议 0-H323； 1-SIP； 2-rtc；
audio_formats	array	音频格式列表 不填默认支持所有，空列表默认支持所有 1-G.722； 2-G711(ULAW)； 3-G.711(ALAW)； 4-G.729； 5-G.728； 6-G722.1.C； 7-MP3； 8-G.719； 9-MPEG-4 AAC LC； 10-MPEG-4 AAC LD； 11-MPEG-4 AAC LC(stereo)； 12-MPEG-4 AAC LD(stereo)； 13-OPUS；
keep_calling_members	array	追呼成员数组
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
vmp	object	画面合成设置
mode*	int	画面合成模式 1-定制画面合成； 2-自动画面合成；
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列; 35-五画面: 1大4小，1大上，4小下(1行4列); 6-六画面: 1大5小，1大左上，2小右上(2行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列); 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列); 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列); 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-是；
broadcast*	int	是否向终端广播 0-否； 1-是；
show_mt_name*	int	是否显示别名 0-否； 1-是；
mt_name_style	object	画面合成参数
font_size*	int	台标字体大小，默认为：1 0-小； 1-中； 2-大；
font_color*	str	台标字体三原色#RGB格式，十六进制表示，默认为：#FFFFFF白色
position*	int	台标显示位置，默认为1 0-左上角； 1-左下角； 2-右上角； 3-右下角； 4-底部中间；
members*	array	画面合成成员列表
name*	str	名称 最大字符长度：128个字节 仅当跟随类型为会控指定时才需要输入
account*	str	帐号 最大字符长度：128个字节 仅当跟随类型为会控指定时才需要输入
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
member_type*	int	跟随类型 1-会控指定； 2-发言人跟随； 3-管理方跟随； 4-会议轮询跟随； 6-单通道轮询； 7-内容共享跟随；
chn_idx*	int	在画画合成中的位置
poll	object	单通道轮询设置
mode*	int	轮询模式 1-视频轮询； 3-音视频轮询；
num*	int	轮询次数，0无限次轮询
keep_time*	int	轮询间隔时间(秒)
members*	array	轮询成员列表
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
vips	array	vip成员列表
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
poll	object	轮询设置
mode*	int	轮询模式 1-视频轮询； 3-音视频轮询；
num*	int	轮询次数，0无限次轮询
keep_time*	int	轮询间隔时间(秒)
members*	array	轮询成员列表
name*	str	名称 最大字符长度：128个字节
account*	str	帐号 最大字符长度：128个字节
account_type*	int	帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；
recorder	object	录像设置
publish_mode*	int	发布模式 0-不发布； 1-发布；
dual_stream*	int	是否内容共享录像 0-否； 1-是；
anonymous*	int	是否支持免登陆观看直播 0-不支持； 1-支持；
recorder_mode*	int	录像模式 1-录像； 2-直播； 3-录像+直播；
vrs_id	str	VRS的moid
dcs	object	数据协作
mode*	int	数据协作模式 0-关闭数据协作； 1-管理方控制； 2-自由协作；

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
conf_id	str	会议号码
meeting_id	str	视频会议唯一id
description	str	结果描述

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	删除预约会议
URI	/api/v1/mc/booked_confs/{conf_id}
方法	DELETE
说明	删除预约会议
最低支持版本	3

参数说明

参数名称	数据类型	说明
account_token*	str	通过oauth登录获取到的授权码
_method		若浏览器不支持DELETE，则使用POST请求，并在请求参数中带上_method参数，并设置其值为DELETE，作为不支持DELETE请求的替代方案。

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	表示操作成功或失败
description	str	描述

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	表示操作成功或失败
error_code	int	失败时的错误号
description	str	结果描述

名称	会议名称校验
URI	/api/v1/mc/valid_conf_name
方法	GET
说明	会议名称校验
最低支持版本	3

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
conf_name*	str	会议名称
start_time	str	开始日期，格式为 2020-07-24T15:30:00+08:00，不填表示当前时间
end_time	str	结束时间，格式为 2020-07-24T15:30:00+08:00， 不填表示永久会议
meeting_id	str	会议id，更新会议时必填

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
result	int	校验结果,1表示成功，无重名会议；0表示失败，有重名会议

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码
description	str	结果描述