| 名称 | token获取 |
|---|---|
| URI | /api/v1/system/token |
| 方法 | POST |
| 说明 | token获取 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| oauth_consumer_key* | str | oauth中认证的软件key |
| oauth_consumer_secret* | str | oauth中认证软件key对应的value |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| account_token | str | token，应用权限 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 登陆 |
|---|---|
| URI | /api/v1/system/login |
| 方法 | POST |
| 说明 | 登陆 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
| username* | str | 用户名 |
| password* | str | 密码 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| username | int | 登陆的用户名 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 保持用户心跳 |
|---|---|
| URI | /api/v1/system/heartbeat |
| 方法 | POST |
| 说明 | 成功登陆后，用户有效期为30m，若30m内无操作，则需手动调用该接口保持心跳 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 获取个人模板列表 |
|---|---|
| URI | /api/v1/mc/personal_templates |
| 方法 | GET |
| 说明 | 获取个人模板列表 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 认证token |
| count | int | 获取的个人模板数，默认为10，即在包含start在内的后count条数据，如果参数为0表示获取所有个人模板 |
| order | int | 根据个人模板的最后修改时间排序，默认为0 0-升序； 1-降序； |
| start | int | 个人模板的开始行，默认为0，即从符合条件的数据中的第几行取数据，0为第一行数据 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| total | int | 总数 |
| personal_templates | array | 个人模板数组 |
| template_id | str | 个人模板id |
| name | str | 个人模板名称 最大字符长度：64个字符 |
| 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-开启； |
| conf_type | int | 会议类型 0-传统会议； 1-端口会议； |
| public_conf | int | 是否来宾会议室 0-否； 1-是； |
| 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-是； |
| resolution | int | 分辨率 |
| max_join_mt | int | 最大与会终端数 8-小型8方会议； 32-32方会议； 64-64方会议； 192-大型192方会议； |
| e164 | str | 预分配会议号 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| description | str | 结果描述 |
| 名称 | 获取个人模板详情 |
|---|---|
| URI | /api/v1/mc/personal_templates/{id} |
| 方法 | GET |
| 说明 | 获取个人模板详情 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 认证token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| template_id | str | 个人模板id |
| name | str | 个人模板名称 1.字符限制： a.不支持输入特殊字符：% & * ^ ~ ' " " ? / \ < > | ` " $ b.且首字符和尾字符不支持输入，下划线（_） 减号（-） 小数点（.） @ （除首尾字符可以输入） 2.最大字符长度：64个字节 |
| bitrate | int | 会议码率 |
| closed_conf | int | 会议免打扰 0-关闭； 1-开启； |
| safe_conf | int | 会议安全 0-公开会议； 1-隐藏会议； |
| password | str | 会议密码 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：32个字节 |
| encrypted_type | int | 传输加密类型 0-不加密； 2-AES加密； 3-商密（SM4）； 4-商密（SM1）； |
| encrypted_auth | int | 终端双向认证 0-关闭； 1-开启； |
| conf_type | int | 会议类型 0-传统会议； 1-端口会议； |
| call_mode | int | 呼叫模式 0-手动； 2-自动； |
| call_times | int | 呼叫次数 |
| call_interval | int | 呼叫间隔(秒) |
| mute | int | 初始化哑音 0-否； 1-是； |
| silence | int | 是否开启初始化静音 0-否； 1-是； |
| video_quality | int | 视频质量,其中租赁环境默认设为质量优先，自建环境以api下参为准 0-质量优先； 1-速度优先； |
| one_reforming | int | 归一重整 0-不使用； 1-使用； |
| encrypted_key | str | 传输加密AES加密密钥 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：32个字节 |
| dual_mode | int | 双流权限 0-发言会场； 1-任意会场； |
| doubleflow | int | 成为发言人后立即发起内容共享 0-否； 1-是； |
| voice_activity_detection | int | 是否开启语音激励 0-否； 1-是； |
| vacinterval | int | 语音激励敏感度(s),支持5、15、30、60 |
| 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-否； 1-是； |
| preoccpuy_resource | int | 预占资源 0-否； 1-是； |
| fec_mode | int | FEC开关 0-关闭； 1-开启； |
| mute_filter | int | 是否开启全场哑音例外 0-不对任何人例外； 1-对发言方和管理方例外； |
| duration | int | 会议时长,0是永久会议 |
| e164 | str | 预分配会议号 |
| 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； |
| 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列; |
| voice_hint | int | 是否识别声音来源 0-否； 1-是； |
| broadcast | 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 | 画面合成成员列表 |
| 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 |
| keep_calling_members | array | 追呼成员数组 |
| name | str | 名称 最大字符长度：128个字节 |
| account | str | 帐号 最大字符长度：128个字节 |
| account_type | int | 帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)； |
| dcs | object | 数据协作 |
| mode | int | 数据协作模式 0-关闭数据协作； 1-管理方控制； 2-自由协作； |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| description | str | 结果描述 |
| 名称 | 创建个人模板 |
|---|---|
| URI | /api/v1/mc/personal_templates |
| 方法 | POST |
| 说明 | 创建个人模板 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 通过oauth登录获取到的授权码 |
| params | 请求内容,以json数据形式发送, 需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| name* | str | 个人模板名称 1.字符限制： a.不支持输入特殊字符：% & * ^ ~ ' " " ? / \ < > | ` " $ b.且首字符和尾字符不支持输入，下划线（_） 减号（-） 小数点（.） @ （除首尾字符可以输入） 2.最大字符长度：64个字节 |
| bitrate* | int | 会议码率 |
| closed_conf* | int | 会议免打扰 0-关闭； 1-开启； |
| safe_conf* | int | 会议安全 0-公开会议； 1-隐藏会议； |
| password | str | 会议密码 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：32个字节 |
| encrypted_type* | int | 传输加密类型 0-不加密； 2-AES加密； 3-商密（SM4）； 4-商密（SM1）； |
| encrypted_auth | int | 终端双向认证，默认为0 0-关闭； 1-开启； |
| conf_type* | int | 会议类型 0-传统会议； 1-端口会议； |
| call_mode* | int | 呼叫模式 0-手动； 2-自动； |
| call_times* | int | 呼叫次数 |
| call_interval* | int | 呼叫间隔(秒) |
| mute* | int | 初始化哑音 0-否； 1-是； |
| silence* | int | 是否开启初始化静音 0-否； 1-是； |
| video_quality* | int | 视频质量,其中租赁环境默认设为质量优先，自建环境以api下参为准 0-质量优先； 1-速度优先； |
| one_reforming* | int | 归一重整 0-不使用； 1-使用； |
| encrypted_key | str | 传输加密AES加密密钥 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：32个字节 |
| dual_mode* | int | 双流权限 0-发言会场； 1-任意会场； |
| doubleflow | int | 成为发言人后立即发起内容共享，默认为0 0-否； 1-是； |
| voice_activity_detection* | int | 是否开启语音激励 0-否； 1-是； |
| vacinterval | int | 语音激励敏感度(s),支持5、15、30、60 |
| 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-否； 1-是； |
| preoccpuy_resource* | int | 预占资源 0-否； 1-是； |
| fec_mode | int | FEC开关，默认为0 0-关闭； 1-开启； |
| mute_filter | int | 是否开启全场哑音例外，默认为0 0-不对任何人例外； 1-对发言方和管理方例外； |
| duration | int | 会议时长,0是永久会议，默认为0 |
| bind_e164* | 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； |
| 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列; |
| 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 |
| keep_calling_members | array | 追呼成员数组 |
| name* | str | 发言人名称 最大字符长度：128个字节 |
| account* | str | 帐号 最大字符长度：128个字节 |
| account_type* | int | 帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)； |
| dcs | object | 数据协作 |
| mode* | int | 数据协作模式 0-关闭数据协作； 1-管理方控制； 2-自由协作； |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 表示操作成功或失败 |
| template_id | str | 模板id |
| description | str | 描述 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 表示操作成功或失败 |
| error_code | int | 失败时的错误号 |
| description | str | 结果描述 |
| 名称 | 修改个人模板 |
|---|---|
| URI | /api/v1/mc/personal_templates/{id} |
| 方法 | POST |
| 说明 | 修改个人模板 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 通过oauth登录获取到的授权码 |
| params | 请求内容,以json数据形式发送, 需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| name* | str | 个人模板名称 1.字符限制： a.不支持输入特殊字符：% & * ^ ~ ' " " ? / \ < > | ` " $ b.且首字符和尾字符不支持输入，下划线（_） 减号（-） 小数点（.） @ （除首尾字符可以输入） 2.最大字符长度：64个字节 |
| bitrate* | int | 会议码率 |
| closed_conf* | int | 会议免打扰 0-关闭； 1-开启； |
| safe_conf* | int | 会议安全 0-公开会议； 1-隐藏会议； |
| password | str | 会议密码 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：32个字节 |
| encrypted_type* | int | 传输加密类型 0-不加密； 2-AES加密； 3-商密（SM4）； 4-商密（SM1）； |
| encrypted_auth | int | 终端双向认证，默认为0 0-关闭； 1-开启； |
| conf_type* | int | 会议类型 0-传统会议； 1-端口会议； |
| call_mode* | int | 呼叫模式 0-手动； 2-自动； |
| call_times* | int | 呼叫次数 |
| call_interval* | int | 呼叫间隔(秒) |
| mute* | int | 初始化哑音 0-否； 1-是； |
| silence* | int | 是否开启初始化静音 0-否； 1-是； |
| video_quality* | int | 视频质量,其中租赁环境默认设为质量优先，自建环境以api下参为准 0-质量优先； 1-速度优先； |
| one_reforming* | int | 归一重整 0-不使用； 1-使用； |
| encrypted_key | str | 传输加密AES加密密钥 1.字符限制：仅支持 英文字母(大小写) 数字 下划线（_） 小数点（.） 2.最大字符长度：32个字节 |
| dual_mode* | int | 双流权限 0-发言会场； 1-任意会场； |
| doubleflow | int | 成为发言人后立即发起内容共享，默认为0 0-否； 1-是； |
| voice_activity_detection* | int | 是否开启语音激励 0-否； 1-是； |
| vacinterval | int | 语音激励敏感度(s) |
| 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-否； 1-是； |
| preoccpuy_resource* | int | 预占资源 0-否； 1-是； |
| fec_mode | int | FEC开关，默认为0 0-关闭； 1-开启； |
| mute_filter | int | 是否开启全场哑音例外，默认为0 0-不对任何人例外； 1-对发言方和管理方例外； |
| duration | int | 会议时长,0是永久会议，默认为0 |
| bind_e164* | 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； |
| 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列; |
| 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 |
| keep_calling_members | array | 追呼成员数组 |
| name* | str | 发言人名称 最大字符长度：128个字节 |
| account* | str | 帐号 最大字符长度：128个字节 |
| account_type* | int | 帐号类型 1-moid； 4-非系统邮箱； 5-e164号； 6-电话； 7-ip地址； 8-别名@ip(监控前端)； |
| dcs | object | 数据协作 |
| mode* | int | 数据协作模式 0-关闭数据协作； 1-管理方控制； 2-自由协作； |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 表示操作成功或失败 |
| template_id | str | 模板id |
| description | str | 描述 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 表示操作成功或失败 |
| error_code | int | 失败时的错误号 |
| description | str | 结果描述 |
| 名称 | 删除个人模板 |
|---|---|
| URI | /api/v1/mc/personal_templates/{id} |
| 方法 | DELETE |
| 说明 | 删除个人模板 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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/public_templates |
| 方法 | GET |
| 说明 | 获取公共模板列表 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token | str | 认证token |
| count | int | 获取的公共模板数，默认为10，即在包含start在内的后count条数据，如果参数为0表示获取所有公共模板 |
| order | int | 根据公共模板的创建时间排序，默认为0 0-升序； 1-降序； |
| start | int | 公共模板的开始行，默认为0，即从符合条件的数据中的第几行取数据，0为第一行数据 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| total | int | 总数 |
| public_templates | array | 公共模板数组 |
| template_id | str | 公共模板id |
| name | str | 模板名称 最大字符长度：64个字节 |
| 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-开启； |
| conf_type | int | 会议类型 0-传统会议； 1-端口会议； |
| public_conf | int | 是否来宾会议室 0-否； 1-是； |
| mute | int | 初始化哑音 0-否； 1-是； |
| silence | int | 初始化静音目前不支持设置，默认为0 |
| video_quality | int | 视频质量,其中租赁环境默认设为0，自建环境以api下参为准 0-质量优先；1-速度优先； 0-否； 1-是； |
| one_reforming | int | 归一重整 0-不使用； 1-使用； |
| encrypted_key | str | 传输加密AES加密密钥 最大字符长度：16个字节 |
| dual_mode | int | 双流权限 0-发言会场； 1-任意会场； |
| voice_activity_detection | int | 是否开启语言激励 0-否； 1-是； |
| resolution | int | 分辨率 |
| max_join_mt | int | 最大与会终端数 8-小型8方会议； 32-32方会议； 64-64方会议； 192-大型192方会议； |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| description | str | 结果描述 |
| 名称 | 获取公共模板详情 |
|---|---|
| URI | /api/v1/mc/public_templates/{id} |
| 方法 | GET |
| 说明 | 获取公共模板详情 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 认证token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| template_id | str | 公共模板id |
| name | str | 模板名称 最大字符长度：64个字节 |
| 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-开启； |
| conf_type | int | 会议类型 0-传统会议； 1-端口会议； |
| mute | int | 初始化哑音 0-否； 1-是； |
| silence | int | 初始化静音目前不支持设置，默认为0 |
| 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-是； |
| vacinterval | int | 语音激励敏感度(s) |
| 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-否； 1-是； |
| preoccpuy_resource | int | 预占资源 0-不预占； 1-预占； |
| call_mode | int | 呼叫模式 0-手动； 2-自动； |
| call_times | int | 呼叫次数 |
| call_interval | int | 呼叫间隔(秒) |
| fec_mode | int | FEC开关 0-关闭； 1-开启； |
| mute_filter | int | 是否开启全场哑音例外 0-不对任何人例外； 1-对发言方和管理方例外； |
| duration | int | 会议时长,0是永久会议 |
| 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 | 码率 |
| dcs | object | 数据协作 |
| mode | int | 数据协作模式 0-关闭数据协作； 1-管理方控制； 2-自由协作； |
| mix | object | 混音信息 |
| mode | int | 混音模式 1-智能混音； |
| vmp | object | 画面合成设置 |
| mode | int | 画面合成模式 2-自动画面合成； |
| recorder | object | 录像设置 |
| recorder_mode | int | 录像模式 1-录像； 2-直播； 3-录像+直播； |
| vrs_id | str | VRS的moid |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| description | str | 结果描述 |
| 名称 | 创建公共模板 |
|---|---|
| URI | /api/v1/mc/public_templates |
| 方法 | POST |
| 说明 | 创建公共模板 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 通过oauth登录获取到的授权码 |
| params | 请求内容,以json数据形式发送, 需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| name* | str | 模板名称 最大字符长度：64个字节 |
| 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 0-关闭； 1-开启； |
| conf_type* | int | 会议类型 0-传统会议； 1-端口会议； |
| mute* | int | 初始化哑音 0-否； 1-是； |
| silence* | int | 初始化静音目前不支持设置，默认为0 |
| 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-是； |
| vacinterval* | int | 语音激励敏感度(s) |
| 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-否； 1-是； |
| preoccpuy_resource* | int | 预占资源 0-不预占； 1-预占； |
| call_mode* | int | 呼叫模式 0-手动； 2-自动； |
| call_times* | int | 呼叫次数 |
| call_interval* | int | 呼叫间隔(秒) |
| fec_mode | int | FEC开关，默认为0 0-关闭； 1-开启； |
| mute_filter | int | 是否开启全场哑音例外，默认为0 0-不对任何人例外； 1-对发言方和管理方例外； |
| duration | int | 会议时长,0是永久会议，默认为0 |
| 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 | 码率 |
| dcs | object | 数据协作 |
| mode* | int | 数据协作模式 0-关闭数据协作； 1-管理方控制； 2-自由协作； |
| mix | object | 混音信息 |
| mode* | int | 混音模式 1-智能混音； |
| vmp | object | 画面合成设置 |
| mode* | int | 画面合成模式 2-自动画面合成； |
| recorder | object | 录像设置 |
| recorder_mode* | int | 录像模式 1-录像； 2-直播； 3-录像+直播； |
| vrs_id* | str | VRS的moid |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 表示操作成功或失败 |
| template_id | str | 模板id |
| description | str | 描述 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 表示操作成功或失败 |
| error_code | int | 失败时的错误号 |
| description | str | 结果描述 |
| 名称 | 修改公共模板 |
|---|---|
| URI | /api/v1/mc/public_templates/{id} |
| 方法 | POST |
| 说明 | 修改公共模板 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 通过oauth登录获取到的授权码 |
| params | 请求内容,以json数据形式发送, 需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| name* | str | 模板名称 最大字符长度：64个字节 |
| 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 0-关闭； 1-开启； |
| conf_type* | int | 会议类型 0-传统会议； 1-端口会议； |
| mute* | int | 初始化哑音 0-否； 1-是； |
| silence* | int | 初始化静音目前不支持设置，默认为0 |
| 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-是； |
| vacinterval* | int | 语音激励敏感度(s) |
| 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-否； 1-是； |
| preoccpuy_resource* | int | 预占资源 0-不预占； 1-预占； |
| call_mode* | int | 呼叫模式 0-手动； 2-自动； |
| call_times* | int | 呼叫次数 |
| call_interval* | int | 呼叫间隔(秒) |
| fec_mode | int | FEC开关，默认为0 0-关闭； 1-开启； |
| mute_filter | int | 是否开启全场哑音例外，默认为0 0-不对任何人例外； 1-对发言方和管理方例外； |
| duration | int | 会议时长,0是永久会议，默认为0 |
| 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 | 码率 |
| dcs | object | 数据协作 |
| mode* | int | 数据协作模式 0-关闭数据协作； 1-管理方控制； 2-自由协作； |
| mix | object | 混音信息 |
| mode* | int | 混音模式 1-智能混音； |
| vmp | object | 画面合成设置 |
| mode* | int | 画面合成模式 2-自动画面合成； |
| recorder | object | 录像设置 |
| recorder_mode* | int | 录像模式 1-录像； 2-直播； 3-录像+直播； |
| vrs_id* | str | VRS的moid |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 表示操作成功或失败 |
| template_id | str | 模板id |
| description | str | 描述 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 表示操作成功或失败 |
| description | str | 结果描述 |
| error_code | int | 失败时的错误号 |
| 名称 | 删除公共模板 |
|---|---|
| URI | /api/v1/mc/public_templates/{id} |
| 方法 | DELETE |
| 说明 | 删除公共模板 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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/booked_confs |
| 方法 | GET |
| 说明 | 获取预约会议列表 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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个字节 |
| conf_type | int | 会议类型 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-是； |
| 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方会议； |
| 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 |
| 说明 | 获取预约会议信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| name | str | 会议名称 最大字符长度：64个字节 |
| conf_id | str | 会议号 最大字符长度：48个字节 |
| conf_type | int | 会议类型 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-是； |
| 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) |
| 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方会议； |
| 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-是； |
| preoccpuy_resource | int | 预占资源 0-不预占； 1-预占； |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| description | str | 结果描述 |
| 名称 | 创建会议 |
|---|---|
| URI | /api/v1/mc/confs |
| 方法 | POST |
| 说明 | 创建会议,当create_type为1时,必填参数请根据文档;当create_type不为1时,template_id为必填参数,其余参数是非必填参数 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| create_type | int | 创建会议类型，默认为1 1-及时会议； 2-公共模板； 3-个人模板； 4-根据虚拟会议室创会； |
| template_id | str | 当creat_type不为1时必填，分别对应模板id和虚拟会议室id |
| name* | str | 会议名称 创建虚拟会议室时可填 1.字符限制： a.不支持输入特殊字符：% & * ^ ~ ' " " ? / \ < > | ` " $ b.且首字符和尾字符不支持输入，下划线（_） 减号（-） 小数点（.） @ （除首尾字符可以输入） 2.最大字符长度：64个字节 |
| 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-端口会议； |
| call_mode* | int | 呼叫模式 0-手动； 2-自动； |
| call_times* | int | 呼叫次数 |
| call_interval* | int | 呼叫间隔(秒) |
| fec_mode | int | FEC开关，默认为0 0-关闭； 1-开启； |
| mute_filter | int | 是否开启全场哑音例外，默认为0 0-不开启； 1-开启； |
| mute* | int | 是否开启初始化哑音 0-否； 1-是； |
| silence* | int | 是否开启初始化静音 0-否； 1-是； |
| video_quality* | int | 视频质量,其中租赁环境默认设为质量优先，自建环境以api下参为准 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),支持5、15、30、60 |
| 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-是； |
| preoccpuy_resource* | int | 预占资源 0-否； 1-是； |
| one_reforming* | int | 归一重整 0-不使用； 1-使用； |
| platform_id | str | 创会平台moid，不填则根据用户权限取默认值 |
| 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； |
| 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列; |
| 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 | 会议号码 |
| description | str | 结果描述 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| description | str | 结果描述 |
| 名称 | 结束会议 |
|---|---|
| URI | /api/v1/mc/confs/{conf_id} |
| 方法 | DELETE |
| 说明 | 结束会议 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _method | 若不支持DELETE，则使用POST请求，并在请求带上_method参数，值为DELETE | |
| account_token* | str | 软件权限token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| description | str | 结果描述 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| description | str | 结果描述 |
| 名称 | 获取简单个人模板详情 |
|---|---|
| URI | /api/v1/mc/personal_templates/{id}/simple |
| 方法 | GET |
| 说明 | 获取简单个人模板详情 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 认证token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| template_id | str | 个人模板id |
| name | str | 个人模板名称 最大字符长度：64个字节 |
| bitrate | int | 会议码率 |
| duration | int | 会议时长,0是永久会议 |
| e164 | str | 预分配会议号 |
| 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-开启； |
| conf_type | int | 会议类型 0-传统会议； 1-端口会议； |
| call_mode | int | 呼叫模式 0-手动； 2-自动； |
| call_times | int | 呼叫次数 |
| call_interval | int | 呼叫间隔(秒) |
| mute | int | 初始化哑音 0-否； 1-是； |
| mute_filter | int | 是否开启全场哑音例外 0-不开启； 1-开启； |
| fec_mode | int | FEC开关 0-关闭； 1-开启； |
| silence | int | 初始化静音目前不支持设置，默认为0 |
| video_quality | int | 视频质量 其中租赁环境默认设为0，自建环境以api下参为准 0-质量优先； 1-速度优先； |
| one_reforming | int | 归一重整 0-不使用； 1-使用； |
| encrypted_key | str | 传输加密AES加密密钥 最大字符长度：16个字节 |
| dual_mode | int | 双流权限 0-发言会场； 1-任意会场； |
| doubleflow | int | 成为发言人后立即发起内容共享 0-否； 1-是； |
| voice_activity_detection | int | 是否开启语言激励 0-否； 1-是； |
| 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方会议； |
| invite_num | int | 与会人总数 |
| mix_num | int | 混音成员总数 |
| vmp_num | int | 画面合成成员总数 |
| vip_num | int | vip总数 |
| poll_num | int | 轮询成员总数 |
| 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 | 码率 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| description | str | 结果描述 |
| 名称 | 获取个人模板参会人员 |
|---|---|
| URI | /api/v1/mc/personal_templates/{id}/invite_members |
| 方法 | GET |
| 说明 | 获取个人模板参会人员 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 认证token |
| count | int | 获取的个人模板参会人数量，默认为10，即在包含start在内的后count条数据，如果参数为0表示获取所有参会人员 |
| order | int | 保留 |
| start | int | 个人模板参会人的开始行，默认为0，即从符合条件的数据中的第几行取数据，0为第一行数据 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| template_id | str | 个人模板id |
| total | int | 成员总数 |
| invite_members | int | 账号列表 |
| name | str | 账号名称 最大字符长度：128个字节 |
| account | str | 账号 最大字符长度：128个字节 |
| account_type | int | 帐号类型 1-moid； 4-非系统邮箱； 5-e164号码； 6-电话； 7-ip地址； 8-别名@ip(监控前端)； |
| protocol | int | 呼叫协议 0-H323； 1-SIP； |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| description | str | 结果描述 |
| 名称 | 获取个人模板混音信息 |
|---|---|
| URI | /api/v1/mc/personal_templates/{id}/mix |
| 方法 | GET |
| 说明 | 获取个人模板混音信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 认证token |
| count | int | 获取的个人模板混音人员数量，默认为10，即在包含start在内的后count条数据，如果参数为0表示获取所有混音人员 |
| order | int | 保留 |
| start | int | 个人模板的混音人员开始行，默认为0，即从符合条件的数据中的第几行取数据，0为第一行数据 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| template_id | str | 个人模板id |
| total | int | 成员总数 |
| 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(监控前端)； |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| description | str | 结果描述 |
| 名称 | 获取个人模板VMP信息 |
|---|---|
| URI | /api/v1/mc/personal_templates/{id}/vmp |
| 方法 | GET |
| 说明 | 获取个人模板VMP信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 认证token |
| count | int | 获取的个人模板VMP人员数量，默认为10，即在包含start在内的后count条数据，如果参数为0表示获取所有VMP人员 |
| order | int | 保留 |
| start | int | 个人模板VMP人员开始行，默认为0，即从符合条件的数据中的第几行取数据，0为第一行数据 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| template_id | str | 个人模板id |
| total | int | 成员总数 |
| 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列; |
| voice_hint | int | 是否识别声音来源 0-否； 1-是； |
| broadcast | 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 | 画面合成成员列表 |
| 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(监控前端)； |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| description | str | 结果描述 |
| 名称 | 获取个人模板轮询信息 |
|---|---|
| URI | /api/v1/mc/personal_templates/{id}/poll |
| 方法 | GET |
| 说明 | 获取个人模板轮询信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 认证token |
| count | int | 获取的个人模板轮询人员数量，默认为10，即在包含start在内的后count条数据，如果参数为0表示获取所有轮询人员 |
| order | int | 保留 |
| start | int | 个人模板轮询人员开始行，默认为0，即从符合条件的数据中的第几行取数据，0为第一行数据 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| template_id | str | 个人模板id |
| total | 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(监控前端)； |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| description | str | 结果描述 |
| 名称 | 获取个人模板vip |
|---|---|
| URI | /api/v1/mc/personal_templates/{id}/vip |
| 方法 | GET |
| 说明 | 获取个人模板vip |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 认证token |
| count | int | 获取的个人模板vip人员数量，默认为10，即在包含start在内的后count条数据，如果参数为0表示获取所有vip人员 |
| order | int | 保留 |
| start | int | 个人模板vip人员开始行，默认为0，即从符合条件的数据中的第几行取数据，0为第一行数据 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| template_id | str | 个人模板id |
| total | int | 成员总数 |
| vips | array | vip成员列表 |
| 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/virtual_meeting_rooms |
| 方法 | POST |
| 说明 | 创建虚拟会议室，参数中非必填项默认值为0 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 | 码率 |
| conf_type | 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-是； |
| 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 |
| preoccpuy_resource | int | 预占资源 0-否； 1-是； |
| 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) |
| one_reforming | int | 归一重整 |
| fec_mode | int | FEC开关 0-关闭； 1-开启； |
| 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个字节 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| id | str | 虚拟会议室id |
| description | str | 结果描述 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| description | str | 结果描述 |
| 名称 | 修改虚拟会议室 |
|---|---|
| URI | /api/v1/mc/virtual_meeting_rooms/{id} |
| 方法 | POST |
| 说明 | 修改虚拟会议室，参数中非必填项默认值为0 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 | 码率 |
| conf_type | int | 会议类型 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-是； |
| 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 |
| preoccpuy_resource | int | 预占资源 0-否； 1-是； |
| 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) |
| one_reforming | int | 归一重整 |
| fec_mode | int | FEC开关 0-关闭； 1-开启； |
| 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个字节 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| description | str | 结果描述 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| description | str | 结果描述 |
| 名称 | 删除虚拟会议室 |
|---|---|
| URI | /api/v1/mc/virtual_meeting_rooms/{id} |
| 方法 | DELETE |
| 说明 | 删除虚拟会议室 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 获取虚拟会议室列表 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| description | str | 结果描述 |
| 名称 | 获取虚拟会议室详情 |
|---|---|
| URI | /api/v1/mc/virtual_meeting_rooms/{id} |
| 方法 | GET |
| 说明 | 获取虚拟会议室详情 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 | 码率 |
| conf_name | str | 会议名称，针对使用中的虚拟会议室，如果空闲则为空 |
| conf_type | int | 会议类型 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-是； |
| 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 |
| preoccpuy_resource | int | 预占资源 0-否； 1-是； |
| 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) |
| one_reforming | int | 归一重整 |
| fec_mode | int | FEC开关 0-关闭； 1-开启； |
| 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个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| description | str | 结果描述 |
| 名称 | 获取资源占用情况 |
|---|---|
| URI | /api/v1/mc/resources |
| 方法 | GET |
| 说明 | 获取资源占用情况 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 获取当前用户域可以使用的会议平台 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 获取会议室区域列表 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 创建会议室区域,管理员有权限 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 修改会议室区域,管理员有权限 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 删除会议室区域，管理员有权限 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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个文件 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 认证token |
| file* | File | 文件，该参数需要配合request的content-type改为multipart/form-data一起使用 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| description | str | 结果描述 |
| meeting_file | object | 上传的文件信息 |
| file_id | int | 文件id |
| meeting_id | int | 会议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 |
| 说明 | 删除会议文件 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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天后自动删除, |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 认证token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| total | int | 总数 |
| meeting_files | array | 会议文件数组 |
| file_id | int | 文件id |
| meeting_id | int | 会议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/vc/confs |
| 方法 | GET |
| 说明 | 获取视频会议列表 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
| 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, 值越小, 级别越高(用于抢呼已在其他会议里的终端) |
| voice_activity_detection | int | 是否开启语音激励 0-否； 1-是； |
| vacinterval | int | 语音激励敏感度(s)，最小值5s, 开启语音激励时有效 |
| conf_type | int | 会议类型 0-传统； 1-端口； |
| 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加密； |
| encrypted_auth | int | 终端双向认证 0-关闭； 1-开启； |
| mute | int | 初始化哑音 0-否； 1-是； |
| mute_filter | int | 全场哑音例外，参数为1时，若执行全场哑音操作，主席和发言人不会被哑音，若执行单个哑音操作时可以被哑音 0-否； 1-是； |
| silence | int | 初始化静音 0-否； 1-是； |
| auto_end | int | 自动结会(少于两个终端时自动结会) 0-不自动结会； 1-自动结会； |
| preoccupy_resource | int | 预占资源(创会时就预占音视频适配器) 0-不预占； 1-预占； |
| 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} |
| 方法 | GET |
| 说明 | 获取视频会议详细信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| name | str | 会议名称 最大字符长度：64个字节 |
| meeting_room_name | str | 虚拟会议室名称，当返回为空字符串时说明不是召开的虚拟会议室 |
| conf_id | str | 会议号 最大字符长度：48个字节 |
| conf_level | int | 会议级别：1-16, 值越小, 级别越高(用于抢呼已在其他会议里的终端) |
| conf_type | int | 会议类型 0-传统； 1-端口； |
| 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加密； |
| encrypted_auth | int | 终端双向认证 0-关闭； 1-开启； |
| mute | int | 初始化哑音 0-否； 1-是； |
| mute_filter | int | 全场哑音例外，参数为1时，若执行全场哑音操作，主席和发言人不会被哑音，若执行单个哑音操作时可以被哑音 0-否； 1-是； |
| silence | int | 初始化静音 0-否； 1-是； |
| video_quality | int | 视频质量 0-质量优先； 1-速度优先； |
| encrypted_key | str | 传输加密AES加密密钥 最大字符长度：16字节 |
| dual_mode | int | 双流权限 0-发言会场； 1-任意会场； 2-指定会场； |
| public_conf | int | 是否公共会议室 0-否； 1-是； |
| auto_end | int | 自动结会(少于两个终端时自动结会) 0-不自动结束； 1-自动结束； |
| preoccupy_resource | 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-开启； |
| voice_activity_detection | int | 是否开启语音激励 0-否； 1-是； |
| vacinterval | int | 语音激励敏感度(s)，最小值5s, 开启语音激励时有效 |
| call_times | int | 呼叫次数 |
| call_interval | int | 呼叫间隔(秒) |
| call_mode | int | 呼叫模式 0-手动呼叫； 2-定时呼叫； |
| 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-是； |
| 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 |
| 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 | 码率 |
| 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}/cascades |
| 方法 | GET |
| 说明 | 获取会议级联信息，cascade_id为0代表本级会议 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| name | str | 会议名称 最大字符长度：64个字节 |
| conf_id | str | 会议号 最大字符长度：48个字节 |
| cascade_id | str | 级联号 最大字符长度：48个字节 |
| mt_id | str | 终端号 最大字符长度：48个字节 |
| cascades | array | 级联数组 |
| conf_id | str | 会议号 最大字符长度：48个字节 |
| name | str | 会议名称 最大字符长度：64个字节 |
| cascade_id | str | 级联号 最大字符长度：48个字节 |
| mt_id | str | 终端号 最大字符长度：48个字节 |
| cascades | array | 级联数组 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 获取级联会议终端列表 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/cascades/{cascade_id}/mts |
| 方法 | GET |
| 说明 | 获取下级会议的终端列表，cascade_id为0代表本级会议 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| mts | array | 终端数组 |
| 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-是； |
| rec | int | 是否在录像 0-否； 1-是； |
| poll | int | 是否在轮询 0-否； 1-是； |
| upload | int | 是否在上传 0-否； 1-是； |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 获取本级会议终端列表 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mts |
| 方法 | GET |
| 说明 | 获取本级会议终端列表 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| mts | array | 终端数组 |
| 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-追呼； |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 获取与会终端信息 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mts/{mt_id} |
| 方法 | GET |
| 说明 | 获取与会终端信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| 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 | 当前终端发送的视频源通道号，获取级联终端信息时不返回 |
| 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+; |
| 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+; |
| 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+; |
| a_rcv_chn | array | 音频接收通道 |
| chn_id | int | 通道号 |
| chn_alias | str | 通道别名 |
| a_snd_chn | array | 音频发送通道 |
| chn_id | int | 通道号 |
| chn_alias | str | 通道别名 |
| rcv_volume | int | 接收音量 |
| snd_volume | int | 发送音量 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 批量添加级联终端 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/cascades/{cascade_id}/mts |
| 方法 | POST |
| 说明 | 批量添加本级或下级终端,cascade_id为0代表本级会议，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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； |
| forced_call | int | 是否强制呼叫，仅支持终本级会议的情况，默认是0 0-不强呼； 1-强呼； |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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； |
| mt_id | int | 终端id |
| cascades_id | int | 终端所在会议所属的Mcu索引 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 批量添加本级终端 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mts |
| 方法 | POST |
| 说明 | 批量添加本级终端，添加终端为同步操作，等待终端上线为异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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； |
| 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； |
| mt_id | int | 终端id |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 批量删除终端 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mts |
| 方法 | DELETE |
| 说明 | 批量删除终端，删除本级终端为同步操作，删除下级终端为异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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}/upload |
| 方法 | GET |
| 说明 | 获取本会议上传给上级会议码流的终端信息，仅当本会议为下级会议时有效 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| mt_id | str | 终端号 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 上传终端操作 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/upload |
| 方法 | 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}/upload_poll |
| 方法 | GET |
| 说明 | 获取上传终端轮询信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| state | int | 上传终端轮询状态 0-未轮询； 1-正常轮询； 2-轮询暂停； |
| num | int | 轮询次数，0为一直轮询 |
| keep_time | int | 轮询时间，单位：秒 |
| cur_poll_mt | object | 当前上传轮询的终端 |
| mt_id | str | 终端号 最大字符长度：48个字节 |
| members | array | 上传终端轮询数组 |
| mt_id | str | 终端号 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 开启上传终端轮询 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/upload_poll |
| 方法 | POST |
| 说明 | 开启上传终端轮询，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| num* | int | 轮询次数，0为一直轮询 |
| keep_time* | int | 轮询时间，单位：秒 |
| members* | array | 上传终端轮询数组 |
| mt_id | str | 终端号 最大字符长度：48个字节 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 修改上传终端轮询状态 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/upload_poll/state |
| 方法 | PUT |
| 说明 | 修改上传终端轮询状态，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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}/online_mts |
| 方法 | POST |
| 说明 | 批量呼叫终端，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 批量挂断终端，同步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 获取会议主席 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 仅支持本级会议终端设置为会议主席，同步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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 |
| 说明 | 获取会议发言人 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| mt_id | str | 发言人id 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 指定会议发言人 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/speaker |
| 方法 | PUT |
| 说明 | 指定会议发言人，同步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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 |
| 方法 | GET |
| 说明 | 获取会议双流源 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| mt_id | str | 双流源 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 指定会议双流源 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/dualstream |
| 方法 | PUT |
| 说明 | 指定会议双流源，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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 |
| 说明 | 取消会议双流源，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 延长会议时间，同步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 会场静音操作，同步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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 |
| 说明 | 会场哑音操作，同步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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}/safty |
| 方法 | PUT |
| 说明 | 会议安全操作，同步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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 |
| 说明 | 修改会议名称，同步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 发送短消息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 设置是否强制广播 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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 |
| 说明 | 开启/关闭语音激励，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| state* | int | 语音激励 0-关闭； 1-开启； |
| vacinterval* | int | 语音激励敏感度(s)，最小值5s |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 获取语音激励信息 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/vad |
| 方法 | GET |
| 说明 | 获取语音激励信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| voice_activity_detection | int | 是否开启语音激励 0-否； 1-是； |
| vacinterval | int | 语音激励敏感度(s)，最小值5s, 开启语音激励时有效 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 获取会议混音信息 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mixs/{mix_id} |
| 方法 | GET |
| 说明 | 获取会议混音信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| mode | int | 混音模式 1-智能混音； 2-定制混音； |
| members | array | 混音成员数组 |
| mt_id | str | 成员终端号 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 开启会议混音 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mixs |
| 方法 | POST |
| 说明 | 开启会议混音，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 获取会议画面合成信息,当未开启画面合成时返回错误 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| mode | int | 画面合成模式 1-定制画面合成； 2-自动画面合成； 3-自动画面合成批量轮询； 4-定制画面合成批量轮询； |
| 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列; |
| 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-双流跟随； |
| mt_id | str | 通道终端号，返回当前通道中的终端号 最大字符长度：48个字节 |
| poll | object | 单通道轮询参数，仅member_type为6时返回 |
| num | int | 画面合成批量轮询次数 |
| keep_time | int | 画面合成批量轮询间隔时间,单位：秒 |
| 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 | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 开启会议画面合成 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/vmps |
| 方法 | POST |
| 说明 | 开启会议画面合成，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| mode* | int | 画面合成模式 1-定制画面合成； 2-自动画面合成； 3-自动画面合成批量轮询； 4-定制画面合成批量轮询； |
| 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列; |
| 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个字节 |
| poll | object | 单通道轮询参数，仅member_type为6时有效 |
| num* | int | 画面合成批量轮询次数 |
| keep_time* | int | 画面合成批量轮询间隔时间,单位：秒 |
| 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，异步操作，当未开启画面合成时返回错误 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| mode* | int | 画面合成模式 1-定制画面合成； 2-自动画面合成； 3-自动画面合成批量轮询； 4-定制画面合成批量轮询； |
| 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列; |
| 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个字节 |
| poll | object | 单通道轮询参数，仅member_type为6时有效 |
| num* | int | 画面合成批量轮询次数 |
| keep_time* | int | 画面合成批量轮询间隔时间,单位：秒 |
| 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，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 获取主席轮询信息 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/chairman_poll |
| 方法 | GET |
| 说明 | 获取主席轮询信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| mode | int | 轮询模式 10-主席视频轮询； 11-主席音视频轮询； |
| state | int | 轮询状态 0-未轮询； 1-正常轮询； 2-轮询暂停； |
| num | int | 轮询次数，0为一直轮询 |
| keep_time | int | 轮询时间，单位：秒 |
| cur_poll_mt | object | 当前轮询的终端 |
| mt_id | str | 终端号 最大字符长度：48个字节 |
| members | array | 轮询终端数组 |
| mt_id | str | 终端号 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 开启主席轮询 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/chairman_poll |
| 方法 | PUT |
| 说明 | 开启主席轮询，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _method | 若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT | |
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| mode* | int | 轮询模式 10-主席视频轮询； 11-主席音视频轮询； |
| num* | int | 轮询次数，0为一直轮询 |
| keep_time* | int | 轮询时间，单位：秒 |
| members* | array | 轮询终端数组 |
| mt_id | str | 终端号 最大字符长度：48个字节 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 修改主席轮询状态 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/chairman_poll/state |
| 方法 | PUT |
| 说明 | 修改主席轮询状态，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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 |
| 说明 | 获取会议轮询信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 | 轮询时间，单位：秒 |
| cur_poll_mt | object | 当前轮询的终端 |
| mt_id | str | 终端号 最大字符长度：48个字节 |
| members | array | 轮询终端数组 |
| mt_id | str | 终端号 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 开启会议轮询 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/poll |
| 方法 | PUT |
| 说明 | 开启会议轮询，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _method | 若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT | |
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| mode* | int | 轮询模式 1-视频轮询； 3-音视频轮询； |
| num* | int | 轮询次数，0为一直轮询 |
| keep_time* | int | 轮询时间，单位：秒 |
| members* | array | 轮询终端数组 |
| mt_id | str | 终端号 最大字符长度：48个字节 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 修改会议轮询状态 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/poll/state |
| 方法 | PUT |
| 说明 | 修改轮询状态，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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 |
| 说明 | 开启录像，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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-发布； |
| 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 |
| 说明 | 获取录像状态，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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-否； |
| 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 |
| 说明 | 获取录像列表 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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-发布； |
| 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 |
| 说明 | 修改录像状态，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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 |
| 说明 | 停止录像，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 开始放像，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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 |
| 说明 | 暂停、继续、停止放像，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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 |
| 说明 | 调整放像进度，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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 |
| 说明 | 获取会议放像状态 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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 |
| 说明 | 仅端口会议有用，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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列; 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列; |
| 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个字节 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 获取终端自主画面合成信息 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mtvmps/{mt_id} |
| 方法 | GET |
| 说明 | 仅端口会议有用，当未开启画面合成时会返回错误 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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列; 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列; |
| show_mt_name | int | 是否显示别名 0-不显示； 1-显示； |
| voice_hint | int | 是否识别声音来源 0-否； 1-是； |
| members | array | 自主画面合成成员数组 |
| chn_idx | int | 自主画面合成通道索引，从0开始 |
| member_type | int | 成员类型 0-空； 1-会控指定； |
| mt_id | str | 通道终端号，仅当通道中为会控指定时有效 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 修改终端自主画面合成参数 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mtvmps/{mt_id} |
| 方法 | PUT |
| 说明 | 仅端口会议有用，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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列; 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-是； |
| show_mt_name* | int | 是否显示别名 0-不显示； 1-显示； |
| members | array | 自主画面合成成员数组 |
| chn_idx* | int | 自主画面合成通道索引，从0开始 |
| member_type* | int | 成员类型 0-空； 1-会控指定； |
| mt_id* | str | 通道终端号 最大字符长度：48个字节 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 停止终端自主画面合成 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mtvmps/{mt_id} |
| 方法 | DELETE |
| 说明 | 仅端口会议有用，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 获取开启自主画面合成的终端列表 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mtvmps |
| 方法 | GET |
| 说明 | 获取开启自主画面合成的终端列表，当未开启画面合成时会返回错误 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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列; 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列; |
| show_mt_name | int | 是否显示别名 0-不显示； 1-显示； |
| voice_hint | int | 是否识别声音来源 0-否； 1-是； |
| mt_id | str | 开启自主画面合成的终端号 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 开启电视墙自主画面合成 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/hduvmps |
| 方法 | POST |
| 说明 | 开启电视墙自主画面合成，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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列; |
| hdu_id* | str | 电视墙id 1.字符限制：仅支持数字+下划线（_）+数字的格式 2.最大字符长度：48个字节 |
| show_mt_name* | int | 是否显示别名 0-不显示； 1-显示； |
| members | array | 自主画面合成成员数组 |
| chn_idx* | int | 自主画面合成通道索引，从0开始 |
| member_type* | int | 成员类型 0-空； 1-会控指定； |
| mt_id* | str | 通道终端号，仅当通道中为会控指定时需要 最大字符长度：48个字节 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 获取电视墙自主画面合成信息 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/hduvmps/{hdu_id} |
| 方法 | GET |
| 说明 | 获取电视墙自主画面合成信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| 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列; |
| show_mt_name | int | 是否显示别名 0-不显示； 1-显示； |
| members | array | 自主画面合成成员数组 |
| chn_idx | int | 自主画面合成通道索引，从0开始 |
| member_type | int | 成员类型 0-空； 1-会控指定； |
| mt_id | str | 通道终端号，仅当通道中为会控指定时有效 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 修改电视墙自主画面合成参数 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/hduvmps/{hdu_id} |
| 方法 | PUT |
| 说明 | 修改电视墙自主画面合成参数，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _method | 若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT | |
| account_token* | str | 登陆token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| 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列; |
| show_mt_name* | int | 是否显示别名 0-不显示； 1-显示； |
| members | array | 自主画面合成成员数组 |
| chn_idx* | int | 自主画面合成通道索引，从0开始 |
| member_type* | int | 成员类型 0-空； 1-会控指定； |
| mt_id* | str | 通道终端号，仅当通道中为会控指定时有效 最大字符长度：48个字节 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 停止电视墙自主画面合成 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/hduvmps/{hdu_id} |
| 方法 | DELETE |
| 说明 | 停止电视墙自主画面合成，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 获取开启自主画面合成的电视墙列表 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/hduvmps |
| 方法 | GET |
| 说明 | 仅端口会议有用 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| hdus | array | 开启自主画面合成的电视墙数组 |
| 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列; |
| show_mt_name | int | 是否显示别名 0-不显示； 1-显示； |
| hdu_id | str | 开启自主画面合成的电视墙id 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 获取平台电视墙列表 |
|---|---|
| URI | /api/v1/vc/hdus |
| 方法 | GET |
| 说明 | 获取平台所有电视墙列表 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| hdus | array | 电视墙列表 |
| hdu_id | str | 电视墙id 最大字符长度：48个字节 |
| hdu_name | str | 电视墙名称 最大字符长度：16个字节 |
| occupy | int | 是否被占用 0-否； 1-是； |
| online | int | 是否在线 0-否； 1-是； |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 获取会议电视墙列表 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/hdus |
| 方法 | GET |
| 说明 | 获取本会议占用的电视墙列表 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| hdus | array | 电视墙列表 |
| hdu_id | str | 电视墙id 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 获取电视墙通道信息 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/hdus/{hdu_id} |
| 方法 | GET |
| 说明 | 获取本会议占用的电视墙通道信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| hdu_id | str | 电视墙id 最大字符长度：48个字节 |
| mode | int | 电视墙模式 1-选看； 2-四分屏(仅传统会议有效)； 3-单通道轮询； |
| specific | object | 选看参数 |
| member_type | str | 选看类型 1-指定； 2-发言人跟随； 3-主席跟随； 4-会议轮询跟随； 6-选看画面合成； 7-批量轮询； 10-选看双流； |
| mt_id | str | 选看终端id，仅member_type为 1-指定 时生效 最大字符长度：48个字节 |
| vmp_id | str | 选看画面合成id，仅member_type为 6-选看画面合成 时生效 最大字符长度：48个字节 |
| poll | object | 轮询信息 |
| num | str | 轮询次数 |
| keep_time | str | 轮询间隔（秒） |
| mode | int | 轮询方式 1-仅图像； 3-音视频轮询； |
| members | array | 轮询成员 |
| mt_id | str | 轮询终端 最大字符长度：48个字节 |
| spilt | array | 四分屏 |
| members | array | 分屏成员 |
| chn_idx | int | 四分屏通道号, 从0开始到3 |
| mt_id | str | 分屏内终端 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 开启电视墙 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/hdus |
| 方法 | POST |
| 说明 | 开启电视墙，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| hdu_id* | str | 电视墙id 1.字符限制：仅支持数字+下划线（_）+数字的格式 2.最大字符长度：48个字节 |
| mode* | int | 电视墙模式 1-选看； 2-四分屏(仅传统会议有效)； 3-单通道轮询； |
| specific | object | 选看参数 |
| member_type* | str | 选看类型 1-指定； 2-发言人跟随； 3-主席跟随； 4-会议轮询跟随； 6-选看画面合成； 10-选看双流； |
| mt_id | str | 选看终端id，仅member_type为 1-指定 时生效 最大字符长度：48个字节 |
| vmp_id | str | 选看画面合成id，仅member_type为 6-选看画面合成 时生效 最大字符长度：48个字节 |
| poll | object | 轮询信息 |
| num* | str | 轮询次数，0无限次轮询 |
| keep_time* | str | 轮询间隔（秒） |
| mode* | str | 轮询方式 1-仅图像； 3-音视频轮询； |
| members* | array | 轮询成员 |
| mt_id | str | 轮询终端 最大字符长度：48个字节 |
| spilt | object | 四分屏 |
| members* | object | 分屏成员, 不能为空 |
| chn_idx* | int | 四分屏通道号, 从0开始到3 |
| mt_id* | str | 分屏内终端 最大字符长度：48个字节 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 关闭电视墙 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/hdus/{hdu_id} |
| 方法 | DELETE |
| 说明 | 关闭电视墙，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 获取电视墙批量轮询信息 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/hdupoll |
| 方法 | GET |
| 说明 | 获取会议轮询信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| mode | int | 批量轮询模式 1-自动； 2-定制； |
| state | int | 轮询状态 0-未轮询； 1-正常轮询； 2-轮询暂停； |
| num | int | 轮询次数，0为一直轮询 |
| keep_time | int | 轮询间隔，单位：秒 |
| show_mt_name | int | 是否显示别名 0-不显示； 1-显示； |
| hdus | array | 批量轮询电视墙成员数组 |
| hdu_id | str | 电视墙id 1.字符限制：仅支持数字+下划线（_）+数字的格式 2.最大字符长度：48个字节 |
| members | array | 参与批量轮询电视墙的终端数组 |
| mt_id | str | 终端号 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 开启电视墙批量轮询 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/hdupoll |
| 方法 | POST |
| 说明 | 开启电视墙批量轮询 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| mode* | int | 批量轮询模式 1-自动； 2-定制； |
| num | int | 轮询次数，0为一直轮询 |
| keep_time | int | 轮询间隔，单位：秒 |
| show_mt_name* | int | 是否显示别名 0-不显示； 1-显示； |
| hdus* | array | 批量轮询电视墙成员数组 |
| hdu_id* | str | 电视墙id 1.字符限制：仅支持数字+下划线（_）+数字的格式 2.最大字符长度：48个字节 |
| members* | array | 参与批量轮询电视墙的终端数组，当批量轮询模式为自动时不用填写 |
| mt_id* | str | 终端号 最大字符长度：48个字节 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 修改电视墙批量轮询状态 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/hdupoll/state |
| 方法 | 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}/inspections |
| 方法 | GET |
| 说明 | 终端选看终端或非广播的画面合成(非广播的会议画面合成仅支持传统会议下, 主席终端选看) |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| inspections | array | 选看参数 |
| mode | int | 选看模式 1-视频； 2-音频； |
| src | object | 选看源 |
| type | int | 选看源类型 1-终端； 2-画面合成； |
| mt_id | str | 选看终端号(选看源类型为终端时, 值为终端id； 选看源类型为画面合成时, 值为合成id) 最大字符长度：48个字节； |
| dst | object | 选看目的 |
| mt_id | str | 目的终端号(选看源类型为画面合成时, 必须为主席终端号) 最大字符长度：48个字节 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 开启终端选看 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/inspections |
| 方法 | POST |
| 说明 | 终端选看终端或非广播的画面合成(非广播的会议画面合成仅支持传统会议下, 主席终端选看)，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| mode* | int | 选看模式 1-视频； 2-音频； |
| src* | object | 选看源 |
| type* | int | 选看源类型 1-终端； 2-画面合成； |
| mt_id* | str | 源终端号(仅选看源类型为终端有效) 最大字符长度：48个字节 |
| dst* | object | 选看目的 |
| mt_id* | str | 目的终端号(选看源类型为画面合成时, 必须为主席终端号) 最大字符长度：48个字节 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 取消终端选看 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/inspections/{mt_id}/{mode} |
| 方法 | DELETE |
| 说明 | 终端选看终端或非广播的画面合成(非广播的会议画面合成仅支持传统会议下, 主席终端选看)，异步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 修改终端呼叫模式 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mts/{mt_id}/call_mode |
| 方法 | PUT |
| 说明 | 修改终端呼叫模式 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _method | 若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT | |
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| value* | int | 呼叫模式 0-手动； 2-自动； 3-追呼； |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 终端静音操作 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mts/{mt_id}/silence |
| 方法 | PUT |
| 说明 | 终端静音操作，同步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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}/mts/{mt_id}/mute |
| 方法 | PUT |
| 说明 | 终端哑音操作，同步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _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}/mts/{mt_id}/volume |
| 方法 | PUT |
| 说明 | 修改终端音量，同步操作 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _method | 若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT | |
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| vol_mode* | int | 终端音量设备 1-扬声器； 2-麦克风； |
| vol_value* | int | 音量 0-35 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 终端摄像头控制 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mts/{mt_id}/camera |
| 方法 | POST |
| 说明 | 控制终端摄像头位移、焦距、视野、亮度 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| state* | int | 摄像头状态 0-开始； 1-停止； |
| type* | int | 控制类型 1-上； 2-下； 3-左； 4-右； 5-上左； 6-上右； 7-下左； 8-下右； 9-视野小； 10-视野大； 11-调焦短； 12-调焦长； 13-亮度加； 14-亮度减； 15-自动调焦； |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 获取终端视频源信息 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mts/{mt_id}/videos |
| 方法 | GET |
| 说明 | 获取终端视频源信息，不同步消息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| cur_video_idx | int | 当前终端的视频源通道号 |
| mt_videos | array | 终端视频源数组，最多返回10个视频源 |
| video_idx | int | 视频源通道号 |
| video_alise | str | 视频源别名 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 设置终端当前视频源 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/mts/{mt_id}/videos |
| 方法 | PUT |
| 说明 | 设置终端当前视频源，不同步消息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| video_idx* | int | 终端接收视频源的通道号 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 错误码 |
| 名称 | 设置VIP列表 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/viplist |
| 方法 | PUT |
| 说明 | 设置VIP列表 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| _method | 若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT | |
| account_token* | str | 软件权限token |
| params | 请求内容，以JSON形式发送，需进行UrlEncode |
params示例
params说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| mts* | array | 终端数组，最多支持8个VIP终端 |
| mt_id | str | 终端id，只能是本级终端 |
| cascade_id | str | 终端所属会议的Mcu索引 |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 获取VIP列表 |
|---|---|
| URI | /api/v1/vc/confs/{conf_id}/viplist |
| 方法 | GET |
| 说明 | 获取VIP列表 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| mts | array | 终端数组，最多支持8个VIP终端 |
| mt_id | str | 终端id |
| cascade_id | str | 终端所属会议的Mcu索引 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 获取用户域的vrs地址列表 |
|---|---|
| URI | /api/v1/vc/vrs |
| 方法 | GET |
| 说明 | 获取用户域的vrs地址列表 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| vrs | array | vrs数组 |
| operator | str | 运营商 |
| ip | str | vrs 地址 |
| port | int | vrs 端口 |
| vrs_id | str | vrs的id信息 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |
| 名称 | 获取API版本信息 |
|---|---|
| URI | /api/v1/vc/version |
| 方法 | GET |
| 说明 | 获取API版本信息 |
参数说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| account_token* | str | 登陆token |
成功回复示例
成功回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| version | str | 版本信息 |
失败回复示例
失败回复说明
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| success | int | 是否成功 |
| error_code | int | 失败时的错误号 |