科达视讯平台会控API

视频会议管理

会议管理

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
own_conf	int	是否仅获取与自己相关的会议（自己为创建者或会议成员），默认为0 0-否； 1-是；	否	0
start	int	获取的视频会议列表的起始会议位置, 0表示第一个会议, 默认为0	否	0
count	int	获取的视频会议的个数, 即包括start在内的后count个会议, 0代表获取所有会议, 默认为10	否	0
matches	str	根据会议号码/会议发起人(姓名)/会议名称过滤会议	否
group_sub_conf	int	是否返回分组子会议，默认不返回 0-否； 1-是；	否	0

{
  "success": 1,
  "total": 20,
  "confs": [
    {
      "name": "conf1",
      "user_domain_moid": "2cush7h3qubdb3kv3dvct883",
      "user_domain_name": "科达用户域",
      "video_formats": [
        {
          "bitrate": 2048,
          "format": 4,
          "frame": 30,
          "resolution": 12
        }
      ],
      "meeting_room_name": "",
      "conf_id": "1590333",
      "conf_level": 1,
      "enable_rtc": 0,
      "voice_activity_detection": 0,
      "vacinterval": 5,
      "conf_type": 0,
      "watermark": 0,
      "conf_category": 1,
      "start_time": "2014-12-01T08:12:22+08:00",
      "end_time": "2014-12-02T09:09:09+08:00",
      "duration": 240,
      "bitrate": 8128,
      "closed_conf": 1,
      "safe_conf": 1,
      "auto_end": 0,
      "group_sub_conf": 0,
      "main_meeting_moid": "ae3673a9551745b6a434e27ebdd177b9",
      "preoccupy_resource": 0,
      "encrypted_type": 2,
      "encrypted_frequence": 0,
      "encrypted_auth": 0,
      "mute": 1,
      "multi_stream": 0,
      "mute_filter": 0,
      "force_mute": 0,
      "anonymous_mt": 0,
      "silence": 1,
      "video_quality": 1,
      "encrypted_key": "234234234",
      "dual_mode": 0,
      "dual_lock": 0,
      "public_conf": 1,
      "max_join_mt": 192,
      "force_broadcast": 0,
      "fec_mode": 0,
      "need_password": 1,
      "one_reforming": 0,
      "doubleflow": 0,
      "own_conf": 1,
      "enable_audience": 0,
      "platform_id": "fa050cd1-4b1d-42ab-85e4-0db70605629b",
      "superior_cascade": 0,
      "subordinate_cascade": 0,
      "meeting_id": "111",
      "creator": {
        "name": "mxm",
        "account": "c69da1ef-5930-47e0-9a79-dfa083de0208",
        "account_type": 1,
        "telephone": "85181157",
        "mobile": "13852521511"
      }
    }
  ]
}

参数名称	数据类型	说明
success	int	是否成功
total	int	总会议数
confs	array	会议列表
name	str	会议名称最大字符长度：128个字节，最大字符：32字符
user_domain_moid	str	会议所属的用户域moid
user_domain_name	str	会所属的的用户域名称
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	码率
meeting_room_name	str	虚拟会议室名称，当返回为空字符串时说明不是召开的虚拟会议室
conf_id	str	会议号最大字符长度：48个字节
conf_level	int	会议等级 1—16 数字越大会议等级越高)
enable_rtc	int	是否允许RTC接入 0-关闭； 1-开启；
voice_activity_detection	int	是否开启语音激励 0-否； 1-是；
vacinterval	int	语音激励敏感度，单位: 秒,支持3、5、15、30
conf_type	int	会议类型 0-传统； 1-端口； 2-SFU纯转发会议；
watermark	int	是否开启视频水印 0-未开启； 1-开启；
conf_category	int	会议类别 0-多点会议； 1-(VCS)调度会议； 2-点对点；
start_time	str	会议开始时间（ISO8601:2000格式表示）
end_time	str	会议结束时间（ISO8601:2000格式表示）
duration	int	会议时长，单位:分钟，0为永久会议
bitrate	int	会议码率
closed_conf	int	会议免打扰，开启时终端不可主动入会 0-关闭； 1-开启；
safe_conf	int	会议安全,非管理员和会议成员看不到会议 0-公开会议； 1-隐藏会议；
encrypted_type	int	传输加密类型 0-不加密； 2-AES加密； 3-商密(SM4)； 4-商密(SM1)； 5-量通(SM4)； 6-量通(SM1)；
encrypted_auth	int	终端双向认证 0-关闭； 1-开启；
mute	int	是否关闭所有麦克风 0-否； 1-是；
multi_stream	int	下级会议中的多流终端回传是否开启 0-不开启； 1-开启；
mute_filter	int	全场麦克风例外，参数为1时，若执行关闭全场麦克风操作，主席和发言人麦克风不会被关闭，若执行单个麦克风关闭操作时可以被关闭 0-否； 1-是；
force_mute	int	关闭全场麦克风情况下，是否禁止终端取消自身麦克风被关闭 0-否； 1-是；
anonymous_mt	int	是否支持匿名终端入会 0-否； 1-是；
silence	int	是否关闭所有参会者扬声器 0-否； 1-是；
auto_end	int	自动结会(少于两个终端时自动结会) 0-不自动结会； 1-自动结会；
group_sub_conf	int	是否分组会议子会议 0-否； 1-是；
main_meeting_moid	str	主会议moid
preoccupy_resource	int	预占资源模式(创会时就预占音视频适配器) 0-不预占模式； 1-预占模式； 2-纯转发模式；
video_quality	int	视频质量 0-质量优先； 1-速度优先；
encrypted_key	str	传输加密AES加密密钥最大字符长度：16字节
dual_mode	int	双流权限 0-发言会场； 1-任意会场；
dual_lock	int	双流锁定 0-非锁定模式； 1-锁定模式；
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-是；
own_conf	int	会议是否和我相关（我在会议列表中或我创建的会议） 0-否； 1-是；
enable_audience	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	帐号类型 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
说明	获取正在召开的视频会议详细信息
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "name": "conf1",
  "user_domain_moid": "2cush7h3qubdb3kv3dvct883",
  "user_domain_name": "科达用户域",
  "meeting_room_name": "",
  "cascade_auto_end": 0,
  "machine_room_moid": "mooooooo-oooo-oooo-oooo-defaultmachi",
  "conf_id": "0782542",
  "conf_level": 1,
  "enable_rtc": 0,
  "conf_type": 1,
  "watermark": 0,
  "conf_category": 1,
  "start_time": "2014-12-01T08:12:22+08:00",
  "end_time": "2014-12-02T09:09:09+08:00",
  "duration": 240,
  "bitrate": 8128,
  "closed_conf": 1,
  "safe_conf": 1,
  "encrypted_type": 2,
  "encrypted_frequence": 0,
  "encrypted_auth": 0,
  "call_times": 0,
  "call_interval": 20,
  "call_mode": 0,
  "mute": 1,
  "multi_stream": 0,
  "mute_filter": 0,
  "force_mute": 0,
  "silence": 1,
  "cascade_mode": 0,
  "cascade_upload": 1,
  "cascade_return": 1,
  "cascade_return_para": 0,
  "video_quality": 1,
  "encrypted_key": "234234234",
  "dual_mode": 1,
  "dual_lock": 0,
  "public_conf": 1,
  "auto_end": 0,
  "preoccupy_resource": 0,
  "max_join_mt": 192,
  "force_broadcast": 0,
  "fec_mode": 0,
  "voice_activity_detection": 1,
  "vacinterval": 5,
  "one_reforming": 0,
  "doubleflow": 0,
  "enable_audience": 0,
  "conf_protocol": 0,
  "platform_id": "fa050cd1-4b1d-42ab-85e4-0db70605629b",
  "superior_cascade": 0,
  "subordinate_cascade": 0,
  "meeting_id": "111",
  "creator": {
    "name": "mxm",
    "account": "c69da1ef-5930-47e0-9a79-dfa083de0208",
    "account_type": 1,
    "telephone": "85181157",
    "mobile": "13852521511"
  },
  "video_formats": [
    {
      "format": 4,
      "resolution": 3,
      "frame": 30,
      "bitrate": 8128
    }
  ],
  "vmp_enable": 1,
  "mix_enable": 1,
  "poll_enable": 1,
  "rec_enable": 1,
  "need_password": 1
}

参数名称	数据类型	说明
success	int	是否成功
name	str	会议名称最大字符长度：128个字节，最大字符：32字符，
user_domain_moid	str	会议所属的用户域moid
user_domain_name	str	会所属的的用户域名称
meeting_room_name	str	虚拟会议室名称，当返回为空字符串时说明不是召开的虚拟会议室
cascade_auto_end	int	是否级联会议断开自动结束本会议 0-否； 1-是；
machine_room_moid	str	会议所属机房moid
conf_id	str	会议号最大字符长度：48个字节
conf_level	int	会议等级 1—16 数字越大会议等级越高)
enable_rtc	int	是否允许RTC接入 0-关闭； 1-开启；
conf_type	int	会议类型 0-传统； 1-端口； 2-SFU纯转发会议；
conf_category	int	会议类别 0-多点会议； 1-(VCS)调度会议； 2-点对点；
watermark	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加密； 3-商密(SM4)； 4-商密(SM1)； 5-量通(SM4)； 6-量通(SM1)；
encrypted_auth	int	终端双向认证 0-关闭； 1-开启；
mute	int	是否关闭所有参会者麦克风 0-否； 1-是；
multi_stream	int	下级会议中的多流终端回传是否开启 0-不开启； 1-开启；
mute_filter	int	全场麦克风例外，参数为1时，若执行关闭全场麦克风操作，主席和发言人麦克风不会被关闭，若执行单个麦克风关闭操作时可以被关闭 0-否； 1-是；
force_mute	int	关闭全场麦克风情况下，是否禁止终端取消自身麦克风被关闭 0-否； 1-是；
silence	int	是否关闭所有参会者扬声器 0-否； 1-是；
video_quality	int	视频质量 0-质量优先； 1-速度优先；
encrypted_key	str	传输加密AES加密密钥最大字符长度：16字节
dual_mode	int	双流权限 0-发言会场； 1-任意会场；
dual_lock	int	双流锁定 0-非锁定模式； 1-锁定模式；
public_conf	int	是否公共会议室 0-否； 1-是；
auto_end	int	自动结会(少于两个终端时自动结会) 0-不自动结束； 1-自动结束；
preoccupy_resource	int	预占资源模式(创会时就预占音视频适配器) 0-不预占模式； 1-预占模式； 2-纯转发模式；
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	语音激励敏感度，单位: 秒,支持3、5、15、30
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-是；
rec_enable	int	是否开启录像 0-否； 1-是；
need_password	int	是否需要密码 0-否； 1-是；
one_reforming	int	归一重整，开启该功能后可增强对外厂商终端的兼容，但会使丢包重传失效 0-不启用； 1-启用；
doubleflow	int	成为发言人后立即发起内容共享 0-否； 1-是；
enable_audience	int	是否超大方 0-否； 1-是；
conf_protocol	int	会议优选协议 0-H323； 1-SIP； 2-RTC；
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	帐号类型 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}/delay
方法	POST
说明	延长会议时间，同步操作
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
delay_time	int	延长的时间，单位：分钟	是

{
"success": 1
}

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

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

名称	所有会场扬声器操作
URI	/api/v1/vc/confs/{conf_id}/silence
方法	PUT
说明	关闭会议中所有终端扬声器，同步操作
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
value	int	是否关闭所有会场扬声器 0-否； 1-是；	是

{
"success": 1
}

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

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

名称	所有会场麦克风操作
URI	/api/v1/vc/confs/{conf_id}/mute
方法	PUT
说明	关闭所有会场麦克风操作，同步操作
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
value	int	是否关闭所有会场麦克风 0-否； 1-是；	是
force_mute	int	所有会场麦克风关闭情况下，是否禁止终端开启自身麦克风，默认为0 0-否； 1-是；	是

{
"success": 1
}

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

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

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
safe_conf	int	会议安全,非管理员和会议成员看不到会议 0-公开会议； 1-隐藏会议；	是
closed_conf	int	会议免打扰，开启时终端不可主动入会 0-关闭； 1-开启；	是

参数名称	数据类型	说明	是否必填
password	str	密码，仅限数字，最大字符长度16个字节,空代表清除已设置密码，不修改密码不要携带此参数（加密待定）	否
safe_conf	int	会议安全,非管理员和会议成员看不到会议 0-公开会议； 1-隐藏会议；	是
closed_conf	int	会议免打扰，开启时终端不可主动入会 0-关闭； 1-开启；	是

{
"success": 1
}

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

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

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
value	str	会议名称 1.字符限制： a.仅允许输入英文、汉字、数字、下划线（_）、减号（-）、@、点号（.）、左括号（、右括号）、#号 b.且首字符和尾字符仅允许输入：英文、数字、汉字 2.最大字符长度：128个字节，最大字符：32字符	是

{
"success": 1
}

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

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填
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": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
force_broadcast	int	是否强制广播 0-不强制广播； 1-强制广播；	是

{
"success": 1
}

名称	会场水印操作
URI	/api/v1/vc/confs/{conf_id}/watermark
方法	PUT
说明	会场水印操作，同步操作
最低支持版本	4

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
value	int	水印状态 0-关闭水印； 1-开启水印；	是

{
"success": 1
}

级联会议管理

名称	获取会议级联信息
URI	/api/v1/vc/confs/{conf_id}/cascades
方法	GET
说明	获取会议级联信息，cascade_id为0代表本级会议
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "conf_id": "112233",
  "name": "testconf",
  "cascade_id": "0",
  "mt_id": "0",
  "cascades": [
    {
      "conf_id": "112244",
      "name": "testconf1",
      "cascade_id": "0.1",
      "mt_id": "0.1",
      "cascades": [
        {
          "conf_id": "112255",
          "name": "testconf2",
          "cascade_id": "0.1.1",
          "mt_id": "0.1.1",
          "cascades": []
        },
        {
          "conf_id": "112256",
          "name": "testconf3",
          "cascade_id": "0.1.2",
          "mt_id": "0.1.2",
          "cascades": []
        }
      ]
    }
  ]
}

名称	获取级联会议终端列表
URI	/api/v1/vc/confs/{conf_id}/cascades/{cascade_id}/mts
方法	GET
说明	获取下级会议的终端列表，cascade_id为0代表本级会议
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
cascade_id	str	可从(/api/v1/vc/confs/{conf_id}/cascades)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mts": [
    {
      "account": "0512110000007",
      "account_type": 5,
      "alias": "mt_shanghai",
      "mt_id": "4.1",
      "ip": "172.16.55.4",
      "online": 1,
      "e164": "222123",
      "bitrate": 1024,
      "product_id": "sky_d510_i_1080p60",
      "type": 1,
      "dual": 1,
      "mix": 1,
      "vmp": 0,
      "rec": 0,
      "poll": 0,
      "upload": 0,
      "silence": 0,
      "mute": 1
    }
  ]
}

名称	批量添加级联终端
URI	/api/v1/vc/confs/{conf_id}/cascades/{cascade_id}/mts
方法	POST
说明	批量添加本级或下级终端,cascade_id为0代表本级会议，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
cascade_id	str	可从(/api/v1/vc/confs/{conf_id}/cascades)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填
mts	array	终端数组	是
account	str	终端E164号,IP或电话号码	是
account_type	int	终端类型 4-非系统邮箱； 5-e164号码； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；	是
bitrate	int	呼叫码率	是
protocol	int	终端优选呼叫协议 0-H323； 1-SIP； 2-RTC； 255-无优选；	是

{
  "success": 1,
  "mts": [
    {
      "account": "2322231",
      "account_type": 5,
      "protocol": 0,
      "mt_id": "1",
      "cascades_id": "2"
    },
    {
      "account": "2322232",
      "account_type": 5,
      "protocol": 0,
      "mt_id": "2",
      "cascades_id": "2"
    }
  ]
}

名称	获取上传终端
URI	/api/v1/vc/confs/{conf_id}/upload
方法	GET
说明	获取本会议上传给上级会议码流的终端信息，仅当本会议为下级会议时有效
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1,
"mt_id": "1"
}

名称	上传终端操作
URI	/api/v1/vc/confs/{conf_id}/upload
方法	PUT
说明	本会议上传给上级会议码流的终端操作, 仅当本会议为下级会议时有效，SFU会议不支持该功能，同步操作
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mt_id	str	上传终端号, 为空则取消终端上传最大字符长度：48个字节	是

{
"success": 1
}

终端管理

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mts": [
    {
      "account": "0512110000007",
      "account_type": 5,
      "alias": "mt_shanghai",
      "mt_id": "1",
      "ip": "172.16.55.4",
      "online": 1,
      "e164": "222123",
      "bitrate": 1024,
      "product_id": "sky_d510_i_1080p60",
      "type": 1,
      "dual": 1,
      "mix": 0,
      "vmp": 0,
      "rec": 0,
      "poll": 0,
      "upload": 0,
      "inspection": 0,
      "silence": 0,
      "mute": 1,
      "protocol": 0,
      "call_mode": 0,
      "v_snd_chn_num": 1,
      "v_rcv_chn_num": 1
    }
  ]
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "account": "0512110000007",
  "account_type": 5,
  "alias": "mt_shanghai",
  "mt_id": "11",
  "ip": "172.16.55.4",
  "online": 1,
  "e164": "222123",
  "bitrate": 1024,
  "type": 1,
  "dual": 1,
  "mix": 0,
  "vmp": 1,
  "rec": 0,
  "poll": 0,
  "upload": 0,
  "inspection": 0,
  "silence": 0,
  "mute": 0,
  "rcv_volume": 15,
  "snd_volume": 20,
  "protocol": 0,
  "call_mode": 2,
  "v_snd_chn": [
    {
      "chn_id": 1,
      "chn_alias": "vsrcchn1",
      "bitrate": 0,
      "resolution": 1,
      "format": 5,
      "cur_video_idx": 0,
      "chn_label": 0
    }
  ],
  "v_rcv_chn": [
    {
      "chn_id": 1,
      "chn_alias": "vrcvchn1",
      "bitrate": 0,
      "resolution": 1,
      "format": 5,
      "chn_label": 0
    }
  ],
  "dv_snd_chn": [
    {
      "chn_id": 1,
      "chn_alias": "svsndchn",
      "bitrate": 0,
      "resolution": 1,
      "format": 5,
      "chn_label": 0
    }
  ],
  "dv_rcv_chn": [
    {
      "chn_id": 1,
      "chn_alias": "svrcvchn",
      "bitrate": 0,
      "resolution": 1,
      "format": 5,
      "chn_label": 0
    }
  ],
  "a_snd_chn": [
    {
      "chn_id": 1,
      "chn_alias": "asndchn1",
      "chn_label": 0
    }
  ],
  "a_rcv_chn": [
    {
      "chn_id": 1,
      "chn_alias": "arcvchn1",
      "chn_label": 0
    }
  ]
}

名称	批量添加本级终端
URI	/api/v1/vc/confs/{conf_id}/mts
方法	POST
说明	批量添加本级终端，添加终端为同步操作，等待终端上线为异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填
mts	array	终端数组	是
account	str	终端E164号,IP或电话号码	是
account_type	int	终端类型 4-非系统邮箱； 5-e164号码； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；	是
bitrate	int	呼叫码率	是
protocol	int	终端优选呼叫协议 0-H323； 1-SIP； 2-RTC； 255-无优选；	是

{
  "success": 1,
  "mts": [
    {
      "account": "2322231",
      "account_type": 5,
      "protocol": 0,
      "mt_id": "1"
    },
    {
      "account": "2322232",
      "account_type": 5,
      "protocol": 0,
      "mt_id": "2"
    }
  ]
}

名称	批量删除终端
URI	/api/v1/vc/confs/{conf_id}/mts
方法	DELETE
说明	批量删除终端，删除本级终端为同步操作，删除下级终端为异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mts	array	终端数组	是	[]
mt_id	str	终端号最大字符长度：48个字节	是

{
"success": 1
}

名称	批量呼叫终端
URI	/api/v1/vc/confs/{conf_id}/online_mts
方法	POST
说明	批量呼叫终端，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mts	array	终端数组	是	[]
mt_id	str	终端号最大字符长度：48个字节	是

{
"success": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mts	array	终端数组	是	[]
mt_id	str	终端号最大字符长度：48个字节	是

{
"success": 1
}

名称	修改终端呼叫模式
URI	/api/v1/vc/confs/{conf_id}/mts/{mt_id}/call_mode
方法	PUT
说明	修改终端呼叫模式
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
value	int	呼叫模式 0-手动； 2-自动； 3-追呼；	是

{
"success": 1
}

名称	终端扬声器操作
URI	/api/v1/vc/confs/{conf_id}/mts/{mt_id}/silence
方法	PUT
说明	终端扬声器操作，同步操作
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
value	int	是否关闭扬声器 0-否； 1-是；	是

{
"success": 1
}

名称	终端麦克风操作
URI	/api/v1/vc/confs/{conf_id}/mts/{mt_id}/mute
方法	PUT
说明	开关终端麦克风，同步操作
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
value	int	是否关闭麦克风 0-否； 1-是；	是

{
"success": 1
}

名称	批量操作终端麦克风
URI	/api/v1/vc/confs/{conf_id}/mute_mts
方法	POST
说明	批量终端麦克风操作，同步操作
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
value	int	是否关闭麦克风 0-否； 1-是；	是
mts	array	终端数组	是	[]
mt_id	str	终端号最大字符长度：48个字节	是

{
"success": 1
}

名称	修改终端音量
URI	/api/v1/vc/confs/{conf_id}/mts/{mt_id}/volume
方法	PUT
说明	修改终端音量，同步操作
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
vol_mode	int	终端音量设备 1-扬声器； 2-麦克风；	是
vol_value	int	音量 0-35	是

{
"success": 1
}

名称	终端摄像头控制
URI	/api/v1/vc/confs/{conf_id}/mts/{mt_id}/camera
方法	POST
说明	控制终端摄像头位移、焦距、视野、亮度
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
state	int	摄像头状态 0-开始； 1-停止；	是
type	int	控制类型 1-上； 2-下； 3-左； 4-右； 5-上左； 6-上右； 7-下左； 8-下右； 9-视野大； 10-视野小； 11-调焦长； 12-调焦短； 13-亮度加； 14-亮度减； 15-自动调焦；	是

{
"success": 1
}

名称	获取摄像头预设位
URI	/api/v1/vc/confs/{conf_id}/mts/{mt_id}/camera_pos
方法	GET
说明	获取摄像头预设位
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "pos_list": [
    {
      "pos": 1,
      "pos_name": "1"
    }
  ]
}

名称	终端摄像头预设位操作
URI	/api/v1/vc/confs/{conf_id}/mts/{mt_id}/camera_pos
方法	PUT
说明	终端摄像头预设位操作
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mode	int	操作模式 1-保存预设位； 2-设置摄像头到该预设位；	是
pos	int	预设位编号	是

{
"success": 1
}

名称	获取终端视频源信息
URI	/api/v1/vc/confs/{conf_id}/mts/{mt_id}/videos
方法	GET
说明	获取终端视频源信息，不同步消息，rtc协议注册的终端不支持
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "cur_video_idx": 0,
  "mt_videos": [
    {
      "video_idx": 0,
      "video_alise": "vga"
    }
  ]
}

名称	设置终端当前视频源
URI	/api/v1/vc/confs/{conf_id}/mts/{mt_id}/videos
方法	PUT
说明	设置终端当前视频源，不同步消息，SFU会议不支持该功能
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
video_idx	int	终端接收视频源的通道号	是

{
"success": 1
}

名称	呼叫全部离线终端
URI	/api/v1/vc/confs/{conf_id}/online_mts/all
方法	POST
说明	呼叫全部离线终端
最低支持版本	8

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1
}

名称	终端音频增益
URI	/api/v1/vc/confs/{conf_id}/mts/{mt_id}/audiogain
方法	POST
说明	只支持混音状态下对终端进行音频增益，异步操作，失败原因通过通知消息获取
最低支持版本	9

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
value	int	增益值,范围0-100	是

{
"success": 1
}

轮询管理

名称	获取上传终端轮询信息
URI	/api/v1/vc/confs/{conf_id}/upload_poll
方法	GET
说明	获取上传终端轮询信息
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "state": 1,
  "num": 0,
  "keep_time": 5,
  "poll_index": 1,
  "cur_poll_mt": {
    "mt_id": "1"
  },
  "members": [
    {
      "mt_id": "1",
      "account": "0512110000001"
    }
  ]
}

名称	开启上传终端轮询
URI	/api/v1/vc/confs/{conf_id}/upload_poll
方法	PUT
说明	开启上传终端轮询，SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
num	int	轮询次数，0为一直轮询	是
keep_time	int	轮询时间，单位：秒	是
members	array	上传终端轮询数组	是	[]
mt_id	str	终端号最大字符长度：48个字节	是

{
"success": 1
}

名称	修改上传终端轮询状态
URI	/api/v1/vc/confs/{conf_id}/upload_poll/state
方法	PUT
说明	修改上传终端轮询状态，SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
value	int	上传终端轮询状态 0-停止轮询； 1-暂停轮询； 2-继续轮询；	是

{
"success": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mode": 10,
  "state": 2,
  "num": 0,
  "keep_time": 5,
  "poll_index": 1,
  "cur_poll_mt": {
    "mt_id": "1"
  },
  "members": [
    {
      "account": "172.16.50.42",
      "mt_id": "1"
    },
    {
      "account": "0568412387411",
      "mt_id": "2"
    }
  ]
}

名称	开启主席轮询
URI	/api/v1/vc/confs/{conf_id}/chairman_poll
方法	PUT
说明	开启主席轮询，SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mode	int	轮询模式 10-主席视频轮询； 11-主席音视频轮询；	是
num	int	轮询次数，0为一直轮询	是
keep_time	int	轮询时间，单位：秒	是
members	array	轮询终端数组	是	[]
mt_id	str	终端号最大字符长度：48个字节	是

{
"success": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

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

{
"success": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mode": 1,
  "state": 2,
  "num": 0,
  "keep_time": 5,
  "poll_index": 1,
  "cur_poll_mt": {
    "mt_id": "1"
  },
  "members": [
    {
      "account": "0512110000000",
      "mt_id": "1"
    }
  ]
}

名称	开启会议轮询
URI	/api/v1/vc/confs/{conf_id}/poll
方法	PUT
说明	开启会议轮询，SFU会议不支持该功能，异步操作,失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mode	int	轮询模式 1-视频轮询； 3-轮询成为发言人；	是
num	int	轮询次数，0为一直轮询	是
keep_time	int	轮询时间，单位：秒	是
members	array	轮询终端数组	是	[]
mt_id	str	终端号最大字符长度：48个字节	是

{
"success": 1
}

名称	修改会议轮询状态
URI	/api/v1/vc/confs/{conf_id}/poll/state
方法	PUT
说明	修改轮询状态，SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

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

{
"success": 1
}

主席发言人管理

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1,
"mt_id": "1"
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

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

{
"success": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mt_id": "1",
  "force_broadcast": 0
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mt_id	str	设置发言人的终端号，取消发言人填空最大字符长度：48个字节	是

{
"success": 1
}

双流管理

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1,
"mt_id": "1"
}

名称	指定会议双流源
URI	/api/v1/vc/confs/{conf_id}/dualstream
方法	PUT
说明	指定会议双流源，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	登录token	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

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

{
"success": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mt_id	str	发双流的终端最大字符长度：48个字节	是

{
"success": 1
}

名称	设置双流模式
URI	/api/v1/vc/confs/{conf_id}/dualmode
方法	PUT
说明	设置双流共享模式为任意会场或发言会场
最低支持版本	3

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
value	int	双流开启模式 0-发言会场； 1-任意会场；	是

{
"success": 1
}

名称	获取双流权限列表
URI	/api/v1/vc/confs/{conf_id}/dual_list
方法	GET
说明	获取会议中有双流权限的终端列表
最低支持版本	9

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "dual_mts": [
    {
      "mt_id": "1"
    }
  ]
}

名称	设置双流权限列表
URI	/api/v1/vc/confs/{conf_id}/dual_list
方法	POST
说明	修改列表同设置一样，修改列表成员重新调用即可。如果设置了双流列表，会中修改模式，先调用列表再调用设置模式
最低支持版本	9

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
dual_mts	array	有双流权限的终端数组	是	[]
mt_id	str	终端id	是

{
"success": 1
}

名称	设置双流锁定模式
URI	/api/v1/vc/confs/{conf_id}/duallock
方法	PUT
说明	设置双流锁定模式是非锁定模式或锁定模式
最低支持版本	8

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mode	int	双流锁定模式 0-非锁定模式； 1-锁定模式；	是

{
"success": 1
}

混音管理

名称	开启/关闭语音激励
URI	/api/v1/vc/confs/{conf_id}/vad
方法	PUT
说明	开启/关闭语音激励，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
state	int	语音激励 0-关闭； 1-开启；	是
vacinterval	int	语音激励敏感度，单位: 秒,支持3、5、15、30	是

{
"success": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "voice_activity_detection": 1,
  "vacinterval": 10
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mix_id	str	会议混音器id，默认为1	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mode": 1,
  "members": [
    {
      "account": "0512110000000",
      "mt_id": "2232.1111"
    }
  ]
}

名称	开启会议混音
URI	/api/v1/vc/confs/{conf_id}/mixs
方法	POST
说明	开启会议混音，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mode	int	混音模式 1-智能混音； 2-定制混音；	是
members	array	混音成员数组,mode=2时必传，mode=1可以不传或传空数组	是	[]
mt_id	str	成员终端号最大字符长度：48个字节	是

{
"success": 1
}

名称	停止会议混音
URI	/api/v1/vc/confs/{conf_id}/mixs/{mix_id}
方法	DELETE
说明	会议主混音器，默认mix_id为1，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mix_id	str	会议混音器id，默认为1	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mix_id	str	会议混音器id，默认为1	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
members	array	混音成员数组	是	[]
mt_id	str	成员终端号最大字符长度：48个字节	否

{
"success": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mix_id	str	会议混音器id，默认为1	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
members	array	混音成员数组	是	[]
mt_id	str	成员终端号最大字符长度：48个字节	是

{
"success": 1
}

画面合成管理

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
vmp_id	str	主画面合成id，默认1	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mode": 1,
  "except_self": 0,
  "layout": 2,
  "broadcast": 1,
  "voice_hint": 1,
  "show_mt_name": 1,
  "preferred_style": 0,
  "mt_name_style": {
    "font_size": 0,
    "font_color": "#FFFFFF",
    "position": 1
  },
  "members": [
    {
      "chn_idx": 0,
      "member_type": 1,
      "account": "0512110000001",
      "mt_id": "22.11",
      "mt_chn_idx": 0
    },
    {
      "chn_idx": 1,
      "member_type": 6,
      "mt_id": "1",
      "mt_chn_idx": 0,
      "poll": {
        "num": 0,
        "keep_time": 5,
        "poll_index": 1,
        "members": [
          {
            "account": "0512110000001",
            "mt_id": "1"
          },
          {
            "account": "0512110000002",
            "mt_id": "2"
          }
        ]
      }
    }
  ],
  "poll": {
    "num": 0,
    "keep_time": 5,
    "state": 1,
    "members": [
      {
        "account": "0512110000001",
        "mt_id": "1"
      },
      {
        "account": "0512110000002",
        "mt_id": "2"
      }
    ]
  }
}

名称	开启会议画面合成
URI	/api/v1/vc/confs/{conf_id}/vmps
方法	POST
说明	开启会议画面合成，7.0SP4传统会议开始支持网呈小通道进合成，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mode	int	画面合成模式 1-定制画面合成； 2-自动画面合成； 3-自动画面合成批量轮询； 4-定制画面合成批量轮询；	是
layout	int	画面合成风格: 1-一画面全屏. 2-两画面: 2等大，居中(1行2列). 3-两画面: 1大1小，1大全屏，1小右下. 4-三画面: 等大，1上2下. 5-四画面: 等大，2行2列. 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列). 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列). 8-九画面: 等大，3行3列. 9-十画面： 2大8小，2大左（2行1列），8小右（4行2列）. 10-十三画面： 1大12小，大1左上，4小右上(2行2列)，8小下(2行4列). 11-十六画面: 16等分，4x4. 12-四画面: 1大3小，1大左，3小右(3行1列). 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列). 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列). 15-十画面： 2大8小，2大上（1行2列），8小下（2行4列）. 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列). 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列). 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列). 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列). 21-六画面： 6等大，居中（2行3列）. 22-三画面: 1大2小，1大左，2小右(2行1列). 23-三画面: 等大，1左，2右(2行1列). 26-四画面: 1大3小，1大上，3小下(1行3列). 27-二十五画面: 等大，5行5列. 30-七画面： 1大6小，1大上，6小下（1行6列）. 34-五画面: 1大4小，1大左，4小右(4行1列). 35-五画面: 1大4小，1大上，4小下(1行4列). 38-十一画面: 1大10小，1大上，10小下(2行5列). 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列). 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列). 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列). 49-十八画面： 6大12小，6大上（2行3列），12小下（2行6列）. 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列). 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列)； 61-两画面: 1大1小，1大全屏，1小右上. 62-两画面: 1大1小，1大全屏，1小左下. 63-两画面: 1大1小，1大全屏，1小左上. 64-六画面: 1大5小，1大左，5小右(5行1列)，3小下(1行3列). 65-十一画面: 3大8小，3大上(1行3列)，8小下(2行4列). 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列). 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下(1行6列). 68-两画面： 2等大，居中2行1列. 69-两画面: 1大1小，1大左中，1小右中. 70-三画面： 3等大，居中1行3列. 71-三画面： 3等大，2左(2行1列),1右中. 72-四画面： 1大3小，1大全屏，3小下中（1行3列）. 73-五画面： 1大4小，4小左（4行1列），1大右. 74-六画面： 1大5小，3小左（3行1列），1大右上，2小右下（1行2列. 75-七画面： 3大4小，2大上，4小左下（2行2列），1大右下. 76-八画面： 8等大，居中（2行4列）. 77-八画面： 1大7小，4小左（4行1列），1大右上，3小右下（1行3列）. 78-九画面： 1大8小，1大上，8小下（1行8列）. 79-九画面： 1大8小，1大左上，3小右上（3行1列），5小下（1行5列）. 80-十二画面： 12等大，居中（3行4列）. 81-十三画面： 1大12小，4小左（4行1列），1大中上，4小中下（2行2列），4小右（4行1列）. 82-十四画面： 2大12小，4小左（4行1列），2大右上（1行2列），8小右下（2行4列）. 83-十五画面： 1大14小，5小左（5行1列），1大中上，4小中下（1行4列），5小右（5行1列）. 84-十七画面： 1大16小，10小左（5行2列），1大右上，6小右下（2行3列）. 85-十九画面： 2大17小，5小左（5行1列），2大右上（1行2列），12小右下（3行4列）. 86-二十画面： 20等大，居中（4行5列）. 87-二十一画面： 1大20小，6小左（6行1列），1大中上，8小中下（2行4列），6小右（6行1列）. 88-二十四画面： 24等大，居中（4行6列）. 89-二十四画面： 4大20小，6小左（6行1列），4大中上（2行2列），8小中下（2行4列），6小右（6行1列）.	是
broadcast	int	是否广播 0-否； 1-是；	是
voice_hint	int	是否识别声音来源 0-否； 1-是；	是
show_mt_name	int	是否显示别名 0-否； 1-是；	是
members	array	画面合成成员数组	是	[]
chn_idx	int	画面合成通道索引，从0开始	是
member_type	int	成员类型 1-会控指定； 2-发言人跟随； 3-主席跟随； 4-轮询跟随； 6-单通道轮询； 7-双流跟随；	是
mt_id	str	通道终端号，仅当通道中为会控指定时需要最大字符长度：48个字节	是

{
"success": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
vmp_id	str	主画面合成id，默认1	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mode	int	画面合成模式 1-定制画面合成； 2-自动画面合成； 3-自动画面合成批量轮询； 4-定制画面合成批量轮询；	是
layout	int	画面合成风格: 1-一画面全屏. 2-两画面: 2等大，居中(1行2列). 3-两画面: 1大1小，1大全屏，1小右下. 4-三画面: 等大，1上2下. 5-四画面: 等大，2行2列. 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列). 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列). 8-九画面: 等大，3行3列. 9-十画面： 2大8小，2大左（2行1列），8小右（4行2列）. 10-十三画面： 1大12小，大1左上，4小右上(2行2列)，8小下(2行4列). 11-十六画面: 16等分，4x4. 12-四画面: 1大3小，1大左，3小右(3行1列). 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列). 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列). 15-十画面： 2大8小，2大上（1行2列），8小下（2行4列）. 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列). 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列). 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列). 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列). 21-六画面： 6等大，居中（2行3列）. 22-三画面: 1大2小，1大左，2小右(2行1列). 23-三画面: 等大，1左，2右(2行1列). 26-四画面: 1大3小，1大上，3小下(1行3列). 27-二十五画面: 等大，5行5列. 30-七画面： 1大6小，1大上，6小下（1行6列）. 34-五画面: 1大4小，1大左，4小右(4行1列). 35-五画面: 1大4小，1大上，4小下(1行4列). 38-十一画面: 1大10小，1大上，10小下(2行5列). 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列). 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列). 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列). 49-十八画面： 6大12小，6大上（2行3列），12小下（2行6列）. 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列). 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列)； 61-两画面: 1大1小，1大全屏，1小右上. 62-两画面: 1大1小，1大全屏，1小左下. 63-两画面: 1大1小，1大全屏，1小左上. 64-六画面: 1大5小，1大左，5小右(5行1列)，3小下(1行3列). 65-十一画面: 3大8小，3大上(1行3列)，8小下(2行4列). 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列). 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下(1行6列). 68-两画面： 2等大，居中2行1列. 69-两画面: 1大1小，1大左中，1小右中. 70-三画面： 3等大，居中1行3列. 71-三画面： 3等大，2左(2行1列),1右中. 72-四画面： 1大3小，1大全屏，3小下中（1行3列）. 73-五画面： 1大4小，4小左（4行1列），1大右. 74-六画面： 1大5小，3小左（3行1列），1大右上，2小右下（1行2列. 75-七画面： 3大4小，2大上，4小左下（2行2列），1大右下. 76-八画面： 8等大，居中（2行4列）. 77-八画面： 1大7小，4小左（4行1列），1大右上，3小右下（1行3列）. 78-九画面： 1大8小，1大上，8小下（1行8列）. 79-九画面： 1大8小，1大左上，3小右上（3行1列），5小下（1行5列）. 80-十二画面： 12等大，居中（3行4列）. 81-十三画面： 1大12小，4小左（4行1列），1大中上，4小中下（2行2列），4小右（4行1列）. 82-十四画面： 2大12小，4小左（4行1列），2大右上（1行2列），8小右下（2行4列）. 83-十五画面： 1大14小，5小左（5行1列），1大中上，4小中下（1行4列），5小右（5行1列）. 84-十七画面： 1大16小，10小左（5行2列），1大右上，6小右下（2行3列）. 85-十九画面： 2大17小，5小左（5行1列），2大右上（1行2列），12小右下（3行4列）. 86-二十画面： 20等大，居中（4行5列）. 87-二十一画面： 1大20小，6小左（6行1列），1大中上，8小中下（2行4列），6小右（6行1列）. 88-二十四画面： 24等大，居中（4行6列）. 89-二十四画面： 4大20小，6小左（6行1列），4大中上（2行2列），8小中下（2行4列），6小右（6行1列）.	是
broadcast	int	是否广播 0-否； 1-是；	是
voice_hint	int	是否识别声音来源 0-否； 1-是；	是
show_mt_name	int	是否显示别名 0-否； 1-是；	是
members	array	画面合成成员数组	是	[]
chn_idx	int	画面合成通道索引，从0开始	是
member_type	int	成员类型 1-会控指定； 2-发言人跟随； 3-主席跟随； 4-轮询跟随； 6-单通道轮询； 7-双流跟随；	是
mt_id	str	通道终端号，仅当通道中为会控指定时需要最大字符长度：48个字节	是

{
"success": 1
}

名称	停止会议画面合成
URI	/api/v1/vc/confs/{conf_id}/vmps/{vmp_id}
方法	DELETE
说明	会议主画面合成，默认vmp_id为1，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
vmp_id	str	主画面合成id，默认1	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1
}

录像放像管理

名称	获取用户域的vrs地址列表
URI	/api/v1/vc/vrs
方法	GET
说明	获取用户域的vrs地址列表
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "vrs": [
    {
      "operator": "中国电信",
      "ip": "172.16.0.14",
      "port": 8070,
      "vrs_id": "81dac790-056b-40ea-8e52-05547bb656d9"
    },
    {
      "operator": "中国联通",
      "ip": "172.16.0.15",
      "port": 8071,
      "vrs_id": "54cab654-076c-87ed-9c67-19065cc787f5"
    }
  ]
}

名称	开启录像
URI	/api/v1/vc/confs/{conf_id}/recorders
方法	POST
说明	异步操作，失败原因通过通知消息获取，7.0SP4后支持SFU会议
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
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": 1,
"rec_id": "1"
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
rec_id	str	录像id,可从开启录像/获取录像列表接口返回获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "video_name": "rectest",
  "recorder_type": 2,
  "state": 1,
  "anonymous": 0,
  "recorder_mode": 1,
  "recorder_source": 0,
  "main_stream": 1,
  "dual_stream": 1,
  "publish_mode": 0,
  "watermark": 0,
  "current_progress": 1,
  "members": [
    {
      "mt_id": "1"
    },
    {
      "mt_id": "2"
    }
  ]
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "recorders": [
    {
      "rec_id": "22",
      "video_name": "rectest",
      "recorder_type": 2,
      "state": 1,
      "anonymous": 0,
      "recorder_mode": 1,
      "main_stream": 1,
      "dual_stream": 1,
      "publish_mode": 0,
      "watermark": 0,
      "current_progress": 1,
      "members": [
        {
          "mt_id": "1"
        },
        {
          "mt_id": "2"
        }
      ]
    },
    {
      "rec_id": "23",
      "video_name": "recname",
      "recorder_type": 2,
      "state": 1,
      "anonymous": 0,
      "recorder_mode": 1,
      "main_stream": 1,
      "dual_stream": 1,
      "publish_mode": 0,
      "watermark": 0,
      "current_progress": 22,
      "members": [
        {
          "mt_id": "1"
        },
        {
          "mt_id": "2"
        }
      ]
    }
  ]
}

名称	修改录像状态
URI	/api/v1/vc/confs/{conf_id}/recorders/{rec_id}/state
方法	PUT
说明	修改录像状态，7.0SP4后支持SFU会议，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
rec_id	str	录像id,可从开启录像/获取录像列表接口返回获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
value	int	录像状态 1-暂停录像； 2-继续录像；	是
recorder_mode	int	录像模式 1-录像； 2-直播； 3-录像+直播；	是

{
"success": 1
}

名称	停止录像
URI	/api/v1/vc/confs/{conf_id}/recorders/{rec_id}
方法	DELETE
说明	停止录像，7.0SP4后支持SFU会议，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
rec_id	str	录像id,可从开启录像/获取录像列表接口返回获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
recorder_mode	int	录像模式 1-录像； 2-直播； 3-录像+直播；	是

{
"success": 1
}

名称	开始放像
URI	/api/v1/vc/confs/{conf_id}/playback
方法	PUT
说明	开始放像时不要同时开启画面合成，SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填
play_dual_stream	int	是否播放双流 0-否； 1-是；	是
file_name	str	放像文件名，最大128字节	是
file_id	int	播放文件的文件id	是
vrs_id	str	vrs的id信息,用于指定放像的vrs,可从(/api/v1/vc/vrs)接口获取	是

{
"success": 1,
"rec_id": "1"
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
value	int	放像状态 0-未放像； 1-暂停放像； 2-正在放像；	是

{
"success": 1
}

名称	调整放像进度
URI	/api/v1/vc/confs/{conf_id}/playback/current_progress
方法	PUT
说明	调整放像进度，SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
current_progress	int	调整的进度,单位：秒	是

{
"success": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "file_name": "1234560000260-2017021011054732-27.asf",
  "file_id": 14035,
  "state": 23,
  "current_progress": 120,
  "total_time": 3600
}

终端自主画面合成管理

名称	开启终端自主画面合成
URI	/api/v1/vc/confs/{conf_id}/mtvmps
方法	POST
说明	仅端口(混合)会议有用，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mode	int	自主画面合成模式 1-定制画面合成； 2-自动画面合成；	是
layout	int	画面合成风格: 1-一画面全屏. 2-两画面: 2等大，居中(1行2列). 3-两画面: 1大1小，1大全屏，1小右下. 4-三画面: 等大，1上2下. 5-四画面: 等大，2行2列. 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列). 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列). 8-九画面: 等大，3行3列. 9-十画面： 2大8小，2大左（2行1列），8小右（4行2列）. 10-十三画面： 1大12小，大1左上，4小右上(2行2列)，8小下(2行4列). 11-十六画面: 16等分，4x4. 12-四画面: 1大3小，1大左，3小右(3行1列). 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列). 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列). 15-十画面： 2大8小，2大上（1行2列），8小下（2行4列）. 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列). 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列). 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列). 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列). 21-六画面： 6等大，居中（2行3列）. 22-三画面: 1大2小，1大左，2小右(2行1列). 23-三画面: 等大，1左，2右(2行1列). 26-四画面: 1大3小，1大上，3小下(1行3列). 27-二十五画面: 等大，5行5列. 30-七画面： 1大6小，1大上，6小下（1行6列）. 34-五画面: 1大4小，1大左，4小右(4行1列). 35-五画面: 1大4小，1大上，4小下(1行4列). 38-十一画面: 1大10小，1大上，10小下(2行5列). 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列). 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列). 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列). 49-十八画面： 6大12小，6大上（2行3列），12小下（2行6列）. 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列). 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列)； 61-两画面: 1大1小，1大全屏，1小右上. 62-两画面: 1大1小，1大全屏，1小左下. 63-两画面: 1大1小，1大全屏，1小左上. 64-六画面: 1大5小，1大左，5小右(5行1列)，3小下(1行3列). 65-十一画面: 3大8小，3大上(1行3列)，8小下(2行4列). 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列). 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下(1行6列). 68-两画面： 2等大，居中2行1列. 69-两画面: 1大1小，1大左中，1小右中. 70-三画面： 3等大，居中1行3列. 71-三画面： 3等大，2左(2行1列),1右中. 72-四画面： 1大3小，1大全屏，3小下中（1行3列）. 73-五画面： 1大4小，4小左（4行1列），1大右. 74-六画面： 1大5小，3小左（3行1列），1大右上，2小右下（1行2列. 75-七画面： 3大4小，2大上，4小左下（2行2列），1大右下. 76-八画面： 8等大，居中（2行4列）. 77-八画面： 1大7小，4小左（4行1列），1大右上，3小右下（1行3列）. 78-九画面： 1大8小，1大上，8小下（1行8列）. 79-九画面： 1大8小，1大左上，3小右上（3行1列），5小下（1行5列）. 80-十二画面： 12等大，居中（3行4列）. 81-十三画面： 1大12小，4小左（4行1列），1大中上，4小中下（2行2列），4小右（4行1列）. 82-十四画面： 2大12小，4小左（4行1列），2大右上（1行2列），8小右下（2行4列）. 83-十五画面： 1大14小，5小左（5行1列），1大中上，4小中下（1行4列），5小右（5行1列）. 84-十七画面： 1大16小，10小左（5行2列），1大右上，6小右下（2行3列）. 85-十九画面： 2大17小，5小左（5行1列），2大右上（1行2列），12小右下（3行4列）. 86-二十画面： 20等大，居中（4行5列）. 87-二十一画面： 1大20小，6小左（6行1列），1大中上，8小中下（2行4列），6小右（6行1列）. 88-二十四画面： 24等大，居中（4行6列）. 89-二十四画面： 4大20小，6小左（6行1列），4大中上（2行2列），8小中下（2行4列），6小右（6行1列）.	是
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": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mode": 1,
  "layout": 1,
  "voice_hint": 1,
  "show_mt_name": 1,
  "preferred_style": 0,
  "mt_chn_idx": 0,
  "members": [
    {
      "chn_idx": 0,
      "member_type": 1,
      "mt_id": "1",
      "mt_chn_idx": 0,
      "account": "0512110000001"
    }
  ]
}

名称	修改终端自主画面合成参数
URI	/api/v1/vc/confs/{conf_id}/mtvmps/{mt_id}
方法	PUT
说明	仅端口(混合)会议有用，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mode	int	自主画面合成模式 1-定制画面合成； 2-自动画面合成；	是
layout	int	画面合成风格: 1-一画面全屏. 2-两画面: 2等大，居中(1行2列). 3-两画面: 1大1小，1大全屏，1小右下. 4-三画面: 等大，1上2下. 5-四画面: 等大，2行2列. 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列). 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列). 8-九画面: 等大，3行3列. 9-十画面： 2大8小，2大左（2行1列），8小右（4行2列）. 10-十三画面： 1大12小，大1左上，4小右上(2行2列)，8小下(2行4列). 11-十六画面: 16等分，4x4. 12-四画面: 1大3小，1大左，3小右(3行1列). 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列). 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列). 15-十画面： 2大8小，2大上（1行2列），8小下（2行4列）. 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列). 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列). 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列). 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列). 21-六画面： 6等大，居中（2行3列）. 22-三画面: 1大2小，1大左，2小右(2行1列). 23-三画面: 等大，1左，2右(2行1列). 26-四画面: 1大3小，1大上，3小下(1行3列). 27-二十五画面: 等大，5行5列. 30-七画面： 1大6小，1大上，6小下（1行6列）. 34-五画面: 1大4小，1大左，4小右(4行1列). 35-五画面: 1大4小，1大上，4小下(1行4列). 38-十一画面: 1大10小，1大上，10小下(2行5列). 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列). 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列). 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列). 49-十八画面： 6大12小，6大上（2行3列），12小下（2行6列）. 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列). 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列)； 61-两画面: 1大1小，1大全屏，1小右上. 62-两画面: 1大1小，1大全屏，1小左下. 63-两画面: 1大1小，1大全屏，1小左上. 64-六画面: 1大5小，1大左，5小右(5行1列)，3小下(1行3列). 65-十一画面: 3大8小，3大上(1行3列)，8小下(2行4列). 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列). 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下(1行6列). 68-两画面： 2等大，居中2行1列. 69-两画面: 1大1小，1大左中，1小右中. 70-三画面： 3等大，居中1行3列. 71-三画面： 3等大，2左(2行1列),1右中. 72-四画面： 1大3小，1大全屏，3小下中（1行3列）. 73-五画面： 1大4小，4小左（4行1列），1大右. 74-六画面： 1大5小，3小左（3行1列），1大右上，2小右下（1行2列. 75-七画面： 3大4小，2大上，4小左下（2行2列），1大右下. 76-八画面： 8等大，居中（2行4列）. 77-八画面： 1大7小，4小左（4行1列），1大右上，3小右下（1行3列）. 78-九画面： 1大8小，1大上，8小下（1行8列）. 79-九画面： 1大8小，1大左上，3小右上（3行1列），5小下（1行5列）. 80-十二画面： 12等大，居中（3行4列）. 81-十三画面： 1大12小，4小左（4行1列），1大中上，4小中下（2行2列），4小右（4行1列）. 82-十四画面： 2大12小，4小左（4行1列），2大右上（1行2列），8小右下（2行4列）. 83-十五画面： 1大14小，5小左（5行1列），1大中上，4小中下（1行4列），5小右（5行1列）. 84-十七画面： 1大16小，10小左（5行2列），1大右上，6小右下（2行3列）. 85-十九画面： 2大17小，5小左（5行1列），2大右上（1行2列），12小右下（3行4列）. 86-二十画面： 20等大，居中（4行5列）. 87-二十一画面： 1大20小，6小左（6行1列），1大中上，8小中下（2行4列），6小右（6行1列）. 88-二十四画面： 24等大，居中（4行6列）. 89-二十四画面： 4大20小，6小左（6行1列），4大中上（2行2列），8小中下（2行4列），6小右（6行1列）.	是
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": 1
}

名称	停止终端自主画面合成
URI	/api/v1/vc/confs/{conf_id}/mtvmps/{mt_id}
方法	DELETE
说明	仅端口(混合)会议有用，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mts": [
    {
      "mode": 1,
      "layout": 1,
      "voice_hint": 1,
      "show_mt_name": 1,
      "mt_id": "1",
      "mt_chn_idx": 0
    }
  ]
}

名称	开启终端单通道自主画面合成
URI	/api/v1/vc/confs/{conf_id}/mt_channel_vmps
方法	POST
说明	仅端口(混合)会议有用，异步操作，失败原因通过通知消息获取
最低支持版本	3

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mode	int	自主画面合成模式 1-定制画面合成； 2-自动画面合成；	是
layout	int	画面合成风格: 1-一画面全屏. 2-两画面: 2等大，居中(1行2列). 3-两画面: 1大1小，1大全屏，1小右下. 4-三画面: 等大，1上2下. 5-四画面: 等大，2行2列. 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列). 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列). 8-九画面: 等大，3行3列. 9-十画面： 2大8小，2大左（2行1列），8小右（4行2列）. 10-十三画面： 1大12小，大1左上，4小右上(2行2列)，8小下(2行4列). 11-十六画面: 16等分，4x4. 12-四画面: 1大3小，1大左，3小右(3行1列). 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列). 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列). 15-十画面： 2大8小，2大上（1行2列），8小下（2行4列）. 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列). 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列). 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列). 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列). 21-六画面： 6等大，居中（2行3列）. 22-三画面: 1大2小，1大左，2小右(2行1列). 23-三画面: 等大，1左，2右(2行1列). 26-四画面: 1大3小，1大上，3小下(1行3列). 27-二十五画面: 等大，5行5列. 30-七画面： 1大6小，1大上，6小下（1行6列）. 34-五画面: 1大4小，1大左，4小右(4行1列). 35-五画面: 1大4小，1大上，4小下(1行4列). 38-十一画面: 1大10小，1大上，10小下(2行5列). 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列). 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列). 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列). 49-十八画面： 6大12小，6大上（2行3列），12小下（2行6列）. 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列). 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列)； 61-两画面: 1大1小，1大全屏，1小右上. 62-两画面: 1大1小，1大全屏，1小左下. 63-两画面: 1大1小，1大全屏，1小左上. 64-六画面: 1大5小，1大左，5小右(5行1列)，3小下(1行3列). 65-十一画面: 3大8小，3大上(1行3列)，8小下(2行4列). 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列). 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下(1行6列). 68-两画面： 2等大，居中2行1列. 69-两画面: 1大1小，1大左中，1小右中. 70-三画面： 3等大，居中1行3列. 71-三画面： 3等大，2左(2行1列),1右中. 72-四画面： 1大3小，1大全屏，3小下中（1行3列）. 73-五画面： 1大4小，4小左（4行1列），1大右. 74-六画面： 1大5小，3小左（3行1列），1大右上，2小右下（1行2列. 75-七画面： 3大4小，2大上，4小左下（2行2列），1大右下. 76-八画面： 8等大，居中（2行4列）. 77-八画面： 1大7小，4小左（4行1列），1大右上，3小右下（1行3列）. 78-九画面： 1大8小，1大上，8小下（1行8列）. 79-九画面： 1大8小，1大左上，3小右上（3行1列），5小下（1行5列）. 80-十二画面： 12等大，居中（3行4列）. 81-十三画面： 1大12小，4小左（4行1列），1大中上，4小中下（2行2列），4小右（4行1列）. 82-十四画面： 2大12小，4小左（4行1列），2大右上（1行2列），8小右下（2行4列）. 83-十五画面： 1大14小，5小左（5行1列），1大中上，4小中下（1行4列），5小右（5行1列）. 84-十七画面： 1大16小，10小左（5行2列），1大右上，6小右下（2行3列）. 85-十九画面： 2大17小，5小左（5行1列），2大右上（1行2列），12小右下（3行4列）. 86-二十画面： 20等大，居中（4行5列）. 87-二十一画面： 1大20小，6小左（6行1列），1大中上，8小中下（2行4列），6小右（6行1列）. 88-二十四画面： 24等大，居中（4行6列）. 89-二十四画面： 4大20小，6小左（6行1列），4大中上（2行2列），8小中下（2行4列），6小右（6行1列）.	是
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": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是
mt_chn_idx	str	mt_chn_idx路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mode": 1,
  "layout": 1,
  "voice_hint": 1,
  "show_mt_name": 1,
  "preferred_style": 0,
  "mt_chn_idx": 2,
  "members": [
    {
      "chn_idx": 0,
      "member_type": 1,
      "mt_id": "1",
      "mt_chn_idx": 0,
      "account": "0512110000001"
    }
  ]
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是
mt_chn_idx	str	mt_chn_idx路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mode	int	自主画面合成模式 1-定制画面合成； 2-自动画面合成；	是
layout	int	画面合成风格: 1-一画面全屏. 2-两画面: 2等大，居中(1行2列). 3-两画面: 1大1小，1大全屏，1小右下. 4-三画面: 等大，1上2下. 5-四画面: 等大，2行2列. 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列). 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列). 8-九画面: 等大，3行3列. 9-十画面： 2大8小，2大左（2行1列），8小右（4行2列）. 10-十三画面： 1大12小，大1左上，4小右上(2行2列)，8小下(2行4列). 11-十六画面: 16等分，4x4. 12-四画面: 1大3小，1大左，3小右(3行1列). 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列). 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列). 15-十画面： 2大8小，2大上（1行2列），8小下（2行4列）. 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列). 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列). 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列). 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列). 21-六画面： 6等大，居中（2行3列）. 22-三画面: 1大2小，1大左，2小右(2行1列). 23-三画面: 等大，1左，2右(2行1列). 26-四画面: 1大3小，1大上，3小下(1行3列). 27-二十五画面: 等大，5行5列. 30-七画面： 1大6小，1大上，6小下（1行6列）. 34-五画面: 1大4小，1大左，4小右(4行1列). 35-五画面: 1大4小，1大上，4小下(1行4列). 38-十一画面: 1大10小，1大上，10小下(2行5列). 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列). 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列). 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列). 49-十八画面： 6大12小，6大上（2行3列），12小下（2行6列）. 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列). 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列)； 61-两画面: 1大1小，1大全屏，1小右上. 62-两画面: 1大1小，1大全屏，1小左下. 63-两画面: 1大1小，1大全屏，1小左上. 64-六画面: 1大5小，1大左，5小右(5行1列)，3小下(1行3列). 65-十一画面: 3大8小，3大上(1行3列)，8小下(2行4列). 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列). 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下(1行6列). 68-两画面： 2等大，居中2行1列. 69-两画面: 1大1小，1大左中，1小右中. 70-三画面： 3等大，居中1行3列. 71-三画面： 3等大，2左(2行1列),1右中. 72-四画面： 1大3小，1大全屏，3小下中（1行3列）. 73-五画面： 1大4小，4小左（4行1列），1大右. 74-六画面： 1大5小，3小左（3行1列），1大右上，2小右下（1行2列. 75-七画面： 3大4小，2大上，4小左下（2行2列），1大右下. 76-八画面： 8等大，居中（2行4列）. 77-八画面： 1大7小，4小左（4行1列），1大右上，3小右下（1行3列）. 78-九画面： 1大8小，1大上，8小下（1行8列）. 79-九画面： 1大8小，1大左上，3小右上（3行1列），5小下（1行5列）. 80-十二画面： 12等大，居中（3行4列）. 81-十三画面： 1大12小，4小左（4行1列），1大中上，4小中下（2行2列），4小右（4行1列）. 82-十四画面： 2大12小，4小左（4行1列），2大右上（1行2列），8小右下（2行4列）. 83-十五画面： 1大14小，5小左（5行1列），1大中上，4小中下（1行4列），5小右（5行1列）. 84-十七画面： 1大16小，10小左（5行2列），1大右上，6小右下（2行3列）. 85-十九画面： 2大17小，5小左（5行1列），2大右上（1行2列），12小右下（3行4列）. 86-二十画面： 20等大，居中（4行5列）. 87-二十一画面： 1大20小，6小左（6行1列），1大中上，8小中下（2行4列），6小右（6行1列）. 88-二十四画面： 24等大，居中（4行6列）. 89-二十四画面： 4大20小，6小左（6行1列），4大中上（2行2列），8小中下（2行4列），6小右（6行1列）.	是
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": 1
}

名称	停止终端单通道自主画面合成
URI	/api/v1/vc/confs/{conf_id}/mt_channel_vmps/{mt_id}/{mt_chn_idx}
方法	DELETE
说明	仅端口(混合)会议有用，异步操作，失败原因通过通知消息获取
最低支持版本	3

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是
mt_chn_idx	str	mt_chn_idx路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1
}

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mts": [
    {
      "mode": 1,
      "layout": 1,
      "voice_hint": 1,
      "show_mt_name": 1,
      "mt_id": "1",
      "mt_chn_idx": 2
    }
  ]
}

电视墙管理

名称	获取平台电视墙列表
URI	/api/v1/vc/hdus
方法	GET
说明	获取平台所有电视墙列表
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "hdus": [
    {
      "hdu_id": "8_0",
      "hdu_name": "hdu",
      "occupy": 0,
      "online": 1
    },
    {
      "hdu_id": "8_1",
      "hdu_name": "hdu",
      "occupy": 0,
      "online": 1
    }
  ]
}

名称	获取会议电视墙列表
URI	/api/v1/vc/confs/{conf_id}/hdus
方法	GET
说明	获取本会议占用的电视墙列表
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "hdus": [
    {
      "hdu_id": "8_0"
    },
    {
      "hdu_id": "8_1"
    }
  ]
}

名称	开启电视墙自主画面合成
URI	/api/v1/vc/confs/{conf_id}/hduvmps
方法	POST
说明	开启电视墙自主画面合成，SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
layout	int	画面合成风格: 1-一画面全屏. 2-两画面: 2等大，居中(1行2列). 3-两画面: 1大1小，1大全屏，1小右下. 4-三画面: 等大，1上2下. 5-四画面: 等大，2行2列. 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列). 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列). 8-九画面: 等大，3行3列. 9-十画面： 2大8小，2大左（2行1列），8小右（4行2列）. 10-十三画面： 1大12小，大1左上，4小右上(2行2列)，8小下(2行4列). 11-十六画面: 16等分，4x4. 12-四画面: 1大3小，1大左，3小右(3行1列). 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列). 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列). 15-十画面： 2大8小，2大上（1行2列），8小下（2行4列）. 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列). 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列). 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列). 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列). 21-六画面： 6等大，居中（2行3列）. 22-三画面: 1大2小，1大左，2小右(2行1列). 23-三画面: 等大，1左，2右(2行1列). 26-四画面: 1大3小，1大上，3小下(1行3列). 27-二十五画面: 等大，5行5列. 30-七画面： 1大6小，1大上，6小下（1行6列）. 34-五画面: 1大4小，1大左，4小右(4行1列). 35-五画面: 1大4小，1大上，4小下(1行4列). 38-十一画面: 1大10小，1大上，10小下(2行5列). 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列). 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列). 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列). 49-十八画面： 6大12小，6大上（2行3列），12小下（2行6列）. 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列). 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列)； 61-两画面: 1大1小，1大全屏，1小右上. 62-两画面: 1大1小，1大全屏，1小左下. 63-两画面: 1大1小，1大全屏，1小左上. 64-六画面: 1大5小，1大左，5小右(5行1列)，3小下(1行3列). 65-十一画面: 3大8小，3大上(1行3列)，8小下(2行4列). 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列). 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下(1行6列). 68-两画面： 2等大，居中2行1列. 69-两画面: 1大1小，1大左中，1小右中. 70-三画面： 3等大，居中1行3列. 71-三画面： 3等大，2左(2行1列),1右中. 72-四画面： 1大3小，1大全屏，3小下中（1行3列）. 73-五画面： 1大4小，4小左（4行1列），1大右. 74-六画面： 1大5小，3小左（3行1列），1大右上，2小右下（1行2列. 75-七画面： 3大4小，2大上，4小左下（2行2列），1大右下. 76-八画面： 8等大，居中（2行4列）. 77-八画面： 1大7小，4小左（4行1列），1大右上，3小右下（1行3列）. 78-九画面： 1大8小，1大上，8小下（1行8列）. 79-九画面： 1大8小，1大左上，3小右上（3行1列），5小下（1行5列）. 80-十二画面： 12等大，居中（3行4列）. 81-十三画面： 1大12小，4小左（4行1列），1大中上，4小中下（2行2列），4小右（4行1列）. 82-十四画面： 2大12小，4小左（4行1列），2大右上（1行2列），8小右下（2行4列）. 83-十五画面： 1大14小，5小左（5行1列），1大中上，4小中下（1行4列），5小右（5行1列）. 84-十七画面： 1大16小，10小左（5行2列），1大右上，6小右下（2行3列）. 85-十九画面： 2大17小，5小左（5行1列），2大右上（1行2列），12小右下（3行4列）. 86-二十画面： 20等大，居中（4行5列）. 87-二十一画面： 1大20小，6小左（6行1列），1大中上，8小中下（2行4列），6小右（6行1列）. 88-二十四画面： 24等大，居中（4行6列）. 89-二十四画面： 4大20小，6小左（6行1列），4大中上（2行2列），8小中下（2行4列），6小右（6行1列）.	是
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": 1
}

名称	获取电视墙自主画面合成信息
URI	/api/v1/vc/confs/{conf_id}/hduvmps/{hdu_id}
方法	GET
说明	获取电视墙自主画面合成信息
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
hdu_id	str	hdu_id路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mode": 1,
  "layout": 1,
  "show_mt_name": 1,
  "preferred_style": 0,
  "members": [
    {
      "chn_idx": 0,
      "member_type": 1,
      "account": "0512110000001",
      "mt_id": "1"
    },
    {
      "chn_idx": 1,
      "member_type": 1,
      "account": "172.16.54.51",
      "mt_id": "2"
    }
  ]
}

名称	修改电视墙自主画面合成参数
URI	/api/v1/vc/confs/{conf_id}/hduvmps/{hdu_id}
方法	PUT
说明	修改电视墙自主画面合成参数，SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
hdu_id	str	hdu_id路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
layout	int	画面合成风格: 1-一画面全屏. 2-两画面: 2等大，居中(1行2列). 3-两画面: 1大1小，1大全屏，1小右下. 4-三画面: 等大，1上2下. 5-四画面: 等大，2行2列. 6-六画面: 1大5小，1大左上，2小右上(2行1列)，3小下(1行3列). 7-八画面: 1大7小，1大左上，3小右上(3行1列)，4小下(1行4列). 8-九画面: 等大，3行3列. 9-十画面： 2大8小，2大左（2行1列），8小右（4行2列）. 10-十三画面： 1大12小，大1左上，4小右上(2行2列)，8小下(2行4列). 11-十六画面: 16等分，4x4. 12-四画面: 1大3小，1大左，3小右(3行1列). 13-七画面: 3大4小，2大上(1行2列)，1大左下，4小右下(2行2列). 14-二十画面: 2大18小，2大上(1行2列)，18小下(3行6列). 15-十画面： 2大8小，2大上（1行2列），8小下（2行4列）. 17-十四画面: 2大12小，2大左上(1行2列)，2小右上(2行1列)，10小下(2行5列). 18-十画面: 2大8小，4小上(1行4列)，2大中(1行2列)，4小下(1行4列). 19-十三画面: 1大12小，4小上(1行4列)，2小左中(2行1列)，1大中中，2小右中(2行1列), 4小下(1行4列). 20-十五画面: 3大12小，3大上(1行3列)，12小下(2行6列). 21-六画面： 6等大，居中（2行3列）. 22-三画面: 1大2小，1大左，2小右(2行1列). 23-三画面: 等大，1左，2右(2行1列). 26-四画面: 1大3小，1大上，3小下(1行3列). 27-二十五画面: 等大，5行5列. 30-七画面： 1大6小，1大上，6小下（1行6列）. 34-五画面: 1大4小，1大左，4小右(4行1列). 35-五画面: 1大4小，1大上，4小下(1行4列). 38-十一画面: 1大10小，1大上，10小下(2行5列). 39-十二画面: 3大9小，2大上(1行2列)，1大左下，9小右下(3行3列). 46-十七画面: 1大16小，1大左上，6小右上(3行2列)，10小下(2行5列). 48-十八画面: 6大12小，6小上(1行6列)，6大居中(2行3列)，6小下(1行6列). 49-十八画面： 6大12小，6大上（2行3列），12小下（2行6列）. 51-十九画面: 2大17小，2大左上(1行2列)，2小右上(2行1列)，15小下(3行5列). 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列)； 61-两画面: 1大1小，1大全屏，1小右上. 62-两画面: 1大1小，1大全屏，1小左下. 63-两画面: 1大1小，1大全屏，1小左上. 64-六画面: 1大5小，1大左，5小右(5行1列)，3小下(1行3列). 65-十一画面: 3大8小，3大上(1行3列)，8小下(2行4列). 66-十二画面: 2大10小，2大上(1行2列)，10小下(2行5列). 67-十五画面: 1大14小，1大左上，8小右上(4行2列)，6小下(1行6列). 68-两画面： 2等大，居中2行1列. 69-两画面: 1大1小，1大左中，1小右中. 70-三画面： 3等大，居中1行3列. 71-三画面： 3等大，2左(2行1列),1右中. 72-四画面： 1大3小，1大全屏，3小下中（1行3列）. 73-五画面： 1大4小，4小左（4行1列），1大右. 74-六画面： 1大5小，3小左（3行1列），1大右上，2小右下（1行2列. 75-七画面： 3大4小，2大上，4小左下（2行2列），1大右下. 76-八画面： 8等大，居中（2行4列）. 77-八画面： 1大7小，4小左（4行1列），1大右上，3小右下（1行3列）. 78-九画面： 1大8小，1大上，8小下（1行8列）. 79-九画面： 1大8小，1大左上，3小右上（3行1列），5小下（1行5列）. 80-十二画面： 12等大，居中（3行4列）. 81-十三画面： 1大12小，4小左（4行1列），1大中上，4小中下（2行2列），4小右（4行1列）. 82-十四画面： 2大12小，4小左（4行1列），2大右上（1行2列），8小右下（2行4列）. 83-十五画面： 1大14小，5小左（5行1列），1大中上，4小中下（1行4列），5小右（5行1列）. 84-十七画面： 1大16小，10小左（5行2列），1大右上，6小右下（2行3列）. 85-十九画面： 2大17小，5小左（5行1列），2大右上（1行2列），12小右下（3行4列）. 86-二十画面： 20等大，居中（4行5列）. 87-二十一画面： 1大20小，6小左（6行1列），1大中上，8小中下（2行4列），6小右（6行1列）. 88-二十四画面： 24等大，居中（4行6列）. 89-二十四画面： 4大20小，6小左（6行1列），4大中上（2行2列），8小中下（2行4列），6小右（6行1列）.	是
show_mt_name	int	是否显示别名 0-不显示； 1-显示；	是
members	array	自主画面合成成员数组	是	[]
chn_idx	int	自主画面合成通道索引，从0开始	是
member_type	int	成员类型 0-空； 1-会控指定；	是
mt_id	str	通道终端号，仅当通道中为会控指定时有效最大字符长度：48个字节	是

{
"success": 1
}

名称	停止电视墙自主画面合成
URI	/api/v1/vc/confs/{conf_id}/hduvmps/{hdu_id}
方法	DELETE
说明	停止电视墙自主画面合成，SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
hdu_id	str	hdu_id路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1
}

名称	获取开启自主画面合成的电视墙列表
URI	/api/v1/vc/confs/{conf_id}/hduvmps
方法	GET
说明	仅端口会议有用
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "hdus": [
    {
      "layout": 1,
      "show_mt_name": 1,
      "hdu_id": "1"
    }
  ]
}

名称	获取电视墙通道信息
URI	/api/v1/vc/confs/{conf_id}/hdus/{hdu_id}
方法	GET
说明	获取本会议占用的电视墙通道信息
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
hdu_id	str	hdu_id路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "hdu_id": "8_0",
  "mode": 1,
  "specific": {
    "show_mt_name": 0,
    "member_type": "",
    "mt_id": "2",
    "account": "0512110000001",
    "mt_chn_idx": 0,
    "vmp_id": "1"
  },
  "poll": {
    "show_mt_name": 0,
    "num": 0,
    "mode": 1,
    "keep_time": 15,
    "poll_index": 1,
    "members": [
      {
        "account": "0512110000001",
        "mt_id": "1"
      }
    ]
  },
  "spilt": {
    "show_mt_name": 0,
    "members": [
      {
        "chn_idx": 0,
        "mt_id": "2",
        "account": "0512110000001"
      }
    ]
  }
}

名称	开启电视墙
URI	/api/v1/vc/confs/{conf_id}/hdus
方法	POST
说明	开启电视墙，SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
hdu_id	str	电视墙id 1.字符限制：仅支持数字+下划线（_）+数字的格式 2.最大字符长度：48个字节	是
mode	int	电视墙模式 1-选看； 2-四分屏(仅传统会议有效)； 3-单通道轮询；	是

{
"success": 1
}

名称	电视墙别名操作
URI	/api/v1/vc/confs/{conf_id}/hdus/{hdu_id}/alias
方法	PUT
说明	电视墙别名操作
最低支持版本

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
hdu_id	str	hdu_id路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
show_mt_name	int	是否显示别名 0-不显示； 1-显示；	是

{
"success": 1
}

名称	关闭电视墙
URI	/api/v1/vc/confs/{conf_id}/hdus/{hdu_id}
方法	DELETE
说明	关闭电视墙，SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
hdu_id	str	hdu_id路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1
}

名称	获取电视墙批量轮询列表
URI	/api/v1/vc/confs/{conf_id}/hdupolls
方法	GET
说明	获取电视墙批量轮询列表
最低支持版本	9

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "hdupolls": [
    {
      "hdupoll_id": "0"
    },
    {
      "hdupoll_id": "1"
    }
  ]
}

名称	获取电视墙批量轮询信息
URI	/api/v1/vc/confs/{conf_id}/hdupoll/{hdupoll_id}
方法	GET
说明	获取电视墙轮询信息
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
hdupoll_id	str	hdupoll_id路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mode": 1,
  "state": 2,
  "num": 0,
  "keep_time": 5,
  "show_mt_name": 0,
  "hdus": [
    {
      "hdu_id": "8_0"
    },
    {
      "hdu_id": "8_1"
    }
  ],
  "members": [
    {
      "mt_id": "1"
    },
    {
      "mt_id": "2"
    }
  ]
}

名称	开启电视墙批量轮询
URI	/api/v1/vc/confs/{conf_id}/hdupoll
方法	POST
说明	开启电视墙批量轮询，SFU会议不支持该功能
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mode	int	批量轮询模式 1-自动； 2-定制；	是
num	int	轮询次数，0为一直轮询	是
keep_time	int	轮询间隔，单位：秒	是
show_mt_name	int	是否显示别名 0-不显示； 1-显示；	是
members	array	参与批量轮询电视墙的终端数组，当批量轮询模式为自动时不用填写	是	[]
mt_id	str	终端号最大字符长度：48个字节	是

{
"success": 1,
"poll_id": 1
}

名称	修改电视墙批量轮询状态
URI	/api/v1/vc/confs/{conf_id}/hdupoll/state
方法	PUT
说明	修改电视墙批量轮询状态，SFU会议不支持该功能
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
poll_id	int	批量轮询id	是
value	int	电视墙批量轮询状态 0-停止轮询； 1-暂停轮询； 2-继续轮询；	是

{
"success": 1
}

监控管理

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

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "monitors": [
    {
      "mode": 0,
      "src": {
        "type": 1,
        "mt_id": "1",
        "mt_chn_idx": 0,
        "encrypt": {
          "mode": 0,
          "key": "123456"
        },
        "payload_formats": {
          "real_payload": "96",
          "active_payload": "106"
        },
        "media_formats": {
          "sampling": 0,
          "chn_num": 0,
          "bitrate": 8128,
          "max_frame": 30
        },
        "rtcp": {
          "ip": "127.0.0.1",
          "port": 6655
        }
      },
      "dst": {
        "ip": "12.12.12.12",
        "port": 6615
      }
    },
    {
      "mode": 1,
      "src": {
        "type": 1,
        "mt_id": "2",
        "mt_chn_idx": 0,
        "encrypt": {
          "mode": 0,
          "key": "123456"
        },
        "payload_formats": {
          "real_payload": "96",
          "active_payload": "106"
        },
        "media_formats": {
          "sampling": 7,
          "chn_num": 1,
          "bitrate": 0,
          "max_frame": 0
        },
        "rtcp": {
          "ip": "127.0.0.1",
          "port": 6655
        }
      },
      "dst": {
        "ip": "12.12.12.13",
        "port": 6615
      }
    }
  ]
}

名称	获取监控信息
URI	/api/v1/vc/confs/{conf_id}/monitors/{dst_ip}/{dst_port}
方法	GET
说明	获取监控信息
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
dst_ip	str	dst_ip路径参数	是
dst_port	str	dst_port路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mode": 0,
  "src": {
    "type": 1,
    "mt_id": "1",
    "mt_chn_idx": 0,
    "encrypt": {
      "mode": 0,
      "key": "123456"
    },
    "payload_formats": {
      "real_payload": "96",
      "active_payload": "106"
    },
    "media_formats": {
      "sampling": 0,
      "chn_num": 0,
      "bitrate": 8128,
      "max_frame": 30
    },
    "rtcp": {
      "ip": "127.0.0.1",
      "port": 6655
    }
  },
  "dst": {
    "ip": "12.12.12.12",
    "port": 6615
  }
}

名称	开启监控
URI	/api/v1/vc/confs/{conf_id}/monitors
方法	POST
说明	将监控源的RTP码流发送到指定的IP端口，监控成功后，需要发送心跳消息保持链路，同步操作
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填
mode	int	监控模式 0-视频； 1-音频；	是
src	object	监控源	是
type	int	监控类型 1-终端； 2-画面合成（不支持监控n-1模式）； 3-混音； 4-双流；	是
dst	object	目的地址	是
ip	str	目的ip地址	是
port	int	目的rtp端口	是

{
  "success": 1,
  "mode": 0,
  "src": {
    "type": 1,
    "encrypt": {
      "mode": 0,
      "key": "123456"
    },
    "payload_formats": {
      "real_payload": "96",
      "active_payload": "106"
    },
    "media_formats": {
      "sampling": 0,
      "chn_num": 0,
      "bitrate": 8128,
      "max_frame": 30
    },
    "rtcp": {
      "ip": "127.0.0.1",
      "port": 6655
    }
  },
  "dst": {
    "ip": "12.12.12.12",
    "port": 6615
  }
}

名称	取消监控
URI	/api/v1/vc/confs/{conf_id}/monitors/{dst_ip}/{dst_port}
方法	DELETE
说明	取消监控，同步操作
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
dst_ip	str	开启监控时的目的地址	是
dst_port	str	开启监控时的目的端口	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1
}

名称	监控心跳保活
URI	/api/v1/vc/confs/{conf_id}/monitors_heartbeat
方法	POST
说明	监控成功后，若30s内没收到心跳，将自动停止发送码流，同步操作
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填
monitors	array	该消息需要每10秒发送一次，若30秒未收到，则监控自动停止	是
ip	str	目的ip地址	是
port	int	目的rtp端口	是

{
"success": 1
}

名称	监控请求关键帧
URI	/api/v1/vc/confs/{conf_id}/neediframe/monitors
方法	POST
说明	监控请求视频关键帧，同步操作
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填
dst	object	目的地址	是
ip	str	目的ip地址	是
port	int	目的rtp端口	是

{
"success": 1
}

选看管理

名称	获取终端选看列表
URI	/api/v1/vc/confs/{conf_id}/inspections
方法	GET
说明	终端选看终端或非广播的画面合成(非广播的会议画面合成仅支持传统会议下, 主席终端选看)
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "inspections": [
    {
      "mode": 1,
      "src": {
        "type": 1,
        "mt_id": "3.1"
      },
      "dst": {
        "mt_id": "2"
      }
    },
    {
      "mode": 1,
      "src": {
        "type": 2,
        "mt_id": "1"
      },
      "dst": {
        "mt_id": "2"
      }
    }
  ]
}

名称	开启终端选看
URI	/api/v1/vc/confs/{conf_id}/inspections
方法	POST
说明	传统会议，终端选看终端或画面合成（API-Level<5只支持主席选看终端或非广播合成），SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填
mode	int	选看模式 1-视频； 2-音频；	是
src	object	选看源	是
type	int	选看源类型 1-终端； 2-画面合成；	是
mt_id	str	源终端号(仅选看源类型为终端有效) 最大字符长度：48个字节	是
dst	object	选看目的	是
mt_id	str	目的终端号(选看源类型为画面合成时, 必须为主席终端号) 最大字符长度：48个字节	是

{
"success": 1
}

名称	取消终端选看
URI	/api/v1/vc/confs/{conf_id}/inspections/{mt_id}/{mode}
方法	DELETE
说明	传统会议，终端取消选看终端或画面合成（API-Level<5只支持主席选看终端或非广播合成），SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是
mode	str	选看模式 1-视频； 2-音频；	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1
}

名称	获取终端通道选看列表
URI	/api/v1/vc/confs/{conf_id}/inspection_channels
方法	GET
说明	获取终端通道选看列表
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "inspections": [
    {
      "mode": 1,
      "src": {
        "type": 1,
        "mt_id": "3.1",
        "mt_chn_idx": 0
      },
      "dst": {
        "mt_id": "2",
        "mt_chn_idx": 0
      }
    },
    {
      "mode": 1,
      "src": {
        "type": 2,
        "mt_id": "1",
        "mt_chn_idx": 0
      },
      "dst": {
        "mt_id": "2",
        "mt_chn_idx": 0
      }
    }
  ]
}

名称	开启终端单通道选看
URI	/api/v1/vc/confs/{conf_id}/inspection_channels
方法	POST
说明	端口会议或传统会议（7.0SP4开始支持）多流终端指定通道选看多流终端或(画面合成7.0SP4开始支持)，SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填
mode	int	选看模式 1-视频；	是
src	object	选看源	是
type	int	选看源类型 1-终端； 2-画面合成；	是
mt_id	str	源终端号(仅选看源类型为终端有效) 最大字符长度：48个字节	是
mt_chn_idx	int	源终端通道	是
dst	object	选看目的	是
mt_id	str	目的终端号最大字符长度：48个字节	是

{
"success": 1
}

名称	取消终端单通道选看
URI	/api/v1/vc/confs/{conf_id}/inspection_channels/{mt_id}/{mode}/{mt_chn_idx}
方法	DELETE
说明	传统会议，多流终端取消指定通道选看终端或(画面合成API-Level>=5)，SFU会议不支持该功能，异步操作，失败原因通过通知消息获取
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是
mode	str	选看模式 1-视频； 2-音频；	是
mt_chn_idx	str	指定通道选看的源终端通道id	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1
}

VIP管理

名称	设置VIP列表
URI	/api/v1/vc/confs/{conf_id}/viplist
方法	PUT
说明	只支持本级会议设置VIP列表，SFU会议不支持该功能
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是
_method	str	若不支持PUT，则使用POST请求，并在请求带上_method参数，值为PUT	否

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
mts	array	终端数组，最多支持8个VIP终端	是	[]
mt_id	str	终端id，只能是本级终端	是

{
"success": 1
}

名称	获取VIP列表
URI	/api/v1/vc/confs/{conf_id}/viplist
方法	GET
说明	获取VIP列表，SFU会议不支持该功能
最低支持版本	1

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mts": [
    {
      "mt_id": "1",
      "cascade_id": "0.1.2"
    },
    {
      "mt_id": "2",
      "cascade_id": "0.1.3"
    }
  ]
}

观众管理

名称	获取会议观众列表
URI	/api/v1/vc/confs/{conf_id}/audiences
方法	GET
说明	获取会议观众列表，仅支持超大方会议
最低支持版本	4

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "audiences": [
    {
      "mt_id": "1",
      "account": "0512110000007",
      "alias": "test",
      "type": 1,
      "ip": "10.67.16.22",
      "online": 1,
      "bitrate": 1024,
      "protocol": 0,
      "account_type": 5,
      "call_mode": 0
    }
  ]
}

名称	获取会议观众信息
URI	/api/v1/vc/confs/{conf_id}/audience/{mt_id}
方法	GET
说明	获取会议观众信息，仅支持超大方会议
最低支持版本	4

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过会议观众列表接口获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "mt_id": "101004",
  "account": "0512110000156",
  "alias": "gkmt_156",
  "type": 1,
  "ip": "10.67.16.38",
  "online": 1,
  "bitrate": 1024,
  "protocol": 0,
  "account_type": 5,
  "call_mode": 2,
  "invite_mode": 1,
  "e164": "0512110000156"
}

名称	批量添加观众
URI	/api/v1/vc/confs/{conf_id}/audiences
方法	POST
说明	批量添加观众或者从讨论席切换成观众，切换为异步操作；添加观众为同步操作，等待观众上线为异步操作，仅支持超大方会议，失败原因通过通知消息获取
最低支持版本	4

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填
audiences	array	终端数组	是
account	str	终端E164号,IP或电话号码	是
account_type	int	终端类型 4-非系统邮箱； 5-e164号码； 6-电话； 7-ip地址； 8-别名@ip(监控前端)；	是
bitrate	int	呼叫码率	是
protocol	int	终端优选呼叫协议 0-H323； 1-SIP； 2-RTC； 255-无优选；	是

{
  "success": 1,
  "audiences": [
    {
      "account": "0512110000006",
      "account_type": 5,
      "protocol": 0,
      "mt_id": 1
    },
    {
      "account": "0512110000007",
      "account_type": 5,
      "protocol": 0,
      "mt_id": 2
    }
  ]
}

名称	批量删除观众
URI	/api/v1/vc/confs/{conf_id}/audiences
方法	DELETE
说明	批量删除观众,同步操作，仅支持超大方会议
最低支持版本	4

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
audiences	array	终端数组	是	[]
mt_id	str	终端号最大字符长度：48个字节	是

{
"success": 1
}

名称	批量呼叫观众
URI	/api/v1/vc/confs/{conf_id}/online_audiences
方法	POST
说明	批量呼叫观众，异步操作，仅支持超大方会议，失败原因通过通知消息获取
最低支持版本	4

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
audiences	array	终端数组	是	[]
mt_id	str	终端号最大字符长度：48个字节	是

{
"success": 1
}

名称	批量挂断观众
URI	/api/v1/vc/confs/{conf_id}/online_audiences
方法	DELETE
说明	批量挂断观众，同步操作，仅支持超大方会议
最低支持版本	4

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
audiences	array	终端数组	是
mt_id	str	终端号最大字符长度：48个字节	是

{
"success": 1
}

码流订阅管理

名称	获取单个终端视频流信息
URI	/api/v1/vc/confs/{conf_id}/mts/{mt_id}/streams
方法	GET
说明	只支持混合或rtc会议，同步操作
最低支持版本	7

请求头说明

参数名称	数据类型	说明	是否必填
Content-Type	str	参数类型，application/json	是
Accept	str	接受类型，application/json	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie从(/api/v1/system/login)接口的返回头（Set-Cookie）或返回体（ssotoken）中获取	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "success": 1,
  "secvideo_streams": [
    {
      "idx": 1,
      "resolutions": [
        {
          "height": "180",
          "width": "320"
        },
        {
          "height": "360",
          "width": "640"
        },
        {
          "height": "720",
          "width": "1280"
        }
      ]
    }
  ],
  "video_streams": [
    {
      "idx": 1,
      "resolutions": [
        {
          "height": "180",
          "width": "320"
        },
        {
          "height": "360",
          "width": "640"
        },
        {
          "height": "720",
          "width": "1280"
        }
      ]
    }
  ]
}

名称	订阅主流
URI	/api/v1/vc/confs/{conf_id}/sub/mts/{mt_id}/main/stream_chns/{chn_id}
方法	POST
说明	只支持混合或rtc会议，订阅主流
最低支持版本	7

请求头说明

参数名称	数据类型	说明	是否必填
userdomainmoid	str	登录接口返回的用户域moid	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie为登录接口返回的ssotoken	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是
chn_id	str	chn_id路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "http_status": 201,
  "header": {
    "Location": "xxx",
    "Link.layer": "xxx",
    "Link.server-sent-events": "xxx"
  },
  "body": "answer_sdp"
}

名称	订阅双流
URI	/api/v1/vc/confs/{conf_id}/sub/mts/{mt_id}/dual/stream_chns/{chn_id}
方法	POST
说明	只支持混合或rtc会议，订阅双流
最低支持版本	7

请求头说明

参数名称	数据类型	说明	是否必填
userdomainmoid	str	登录接口返回的用户域moid	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie为登录接口返回的ssotoken	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
mt_id	str	正在召开的会议中的终端唯一识别号，可通过获取本级(级联)会议终端列表获取	是
chn_id	str	chn_id路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "http_status": 201,
  "header": {
    "Location": "xxx",
    "Link.layer": "xxx",
    "Link.server-sent-events": "xxx"
  },
  "body": "answer_sdp"
}

名称	取消订阅
URI	/api/v1/vc/confs/{conf_id}/sub/resource/{endpoint_id}
方法	DELETE
说明	只支持混合或rtc会议，取消订阅
最低支持版本	7

请求头说明

参数名称	数据类型	说明	是否必填
userdomainmoid	str	登录接口返回的用户域moid	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie为登录接口返回的ssotoken	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
endpoint_id	str	endpoint_id路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1
}

名称	获取server-to-client事件流url
URI	/api/v1/vc/confs/{conf_id}/sub/resource/{endpoint_id}/sse
方法	POST
说明	只支持混合或rtc会议
最低支持版本	7

请求头说明

参数名称	数据类型	说明	是否必填
userdomainmoid	str	登录接口返回的用户域moid	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie为登录接口返回的ssotoken	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
endpoint_id	str	endpoint_id路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
"success": 1
}

名称	创建event-stream
URI	/api/v1/vc/confs/{conf_id}/sub/resource/{endpoint_id}/sse/event-stream
方法	GET
说明	只支持混合或rtc会议
最低支持版本	7

请求头说明

参数名称	数据类型	说明	是否必填
userdomainmoid	str	登录接口返回的用户域moid	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie为登录接口返回的ssotoken	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
endpoint_id	str	endpoint_id路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

{
  "http_status": 200,
  "event": "layers",
  "data": " [{ \"spatialLayerId\": 0, \"height\": 270, \"width\": 480 },{ \"spatialLayerId\": 1, \"height\": 540, \"width\": 960 },{ \"spatialLayerId\": 2, \"height\": 1080, \"width\": 1920 }] [{ \"spatialLayerId\": 0, \"height\": 270, \"width\": 480 },{ \"spatialLayerId\": 1, \"height\": 540, \"width\": 960 },{ \"spatialLayerId\": 2, \"height\": 1080, \"width\": 1920 }]"
}

名称	切层
URI	/api/v1/vc/confs/{conf_id}/sub/resource/{endpoint_id}/layer
方法	POST
说明	只支持混合或rtc会议
最低支持版本	7

请求头说明

参数名称	数据类型	说明	是否必填
userdomainmoid	str	登录接口返回的用户域moid	是
Cookie	str	SSO_COOKIE_KEY={cookie}，cookie为登录接口返回的ssotoken	是
API-Level	str	请求的API接口版本	否

URL路径参数说明

参数名称	数据类型	说明	是否必填	默认值
conf_id	str	正在召开的会议id，可从(/api/v1/vc/confs)接口返回中获取	是
endpoint_id	str	endpoint_id路径参数	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	可从(/api/v1/system/token)接口返回中获取	是

显示完整参数

参数名称	数据类型	说明	是否必填	默认值
height	int	高	是
spatialLayerId	int	空域层id	是

{
"success": 1
}

版本信息

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

请求头说明

参数名称	数据类型	说明	是否必填	默认值
Content-Type	str	参数类型，application/json	否
Accept	str	接受类型，application/json	是

URL查询参数说明

参数名称	数据类型	说明	是否必填	默认值
account_token	str	登录token	是

{
  "success": 1,
  "version": "6.0.0.0.0.20190603",
  "api_level": 1
}

科达视讯平台会控API

V10.0.0.0.0.20260513

API_Level:11

视频会议管理

会议管理

级联会议管理

终端管理

轮询管理

主席发言人管理

双流管理

混音管理

画面合成管理

录像放像管理

终端自主画面合成管理

电视墙管理

监控管理

选看管理

VIP管理

观众管理

码流订阅管理

版本信息

会议管理

级联会议管理

终端管理

轮询管理

主席发言人管理

双流管理

混音管理

画面合成管理

录像放像管理

终端自主画面合成管理

电视墙管理

监控管理

选看管理

VIP管理

观众管理

码流订阅管理

版本信息

参数名称	数据类型	说明
success	int	是否成功
pos_list	array	预设位编号数组
pos	int	预设位编号
pos_name	str	预设位别名(终端侧可修改)

参数名称	数据类型	说明
success	int	是否成功
cur_video_idx	int	当前终端的视频源通道号
mt_videos	array	终端视频源数组，最多返回10个视频源
video_idx	int	视频源通道号
video_alise	str	视频源别名

参数名称	数据类型	说明	是否必填	默认值
value	int	双流开启模式 0-发言会场； 1-任意会场；	是
enable_dual_list	int	是否启用双流权限列表，默认不启用（v9.1+） 0-不启用； 1-启用；	否	0

参数名称	数据类型	说明
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-录像+直播；
recorder_source	int	录像管理方接收类型 0-无效值,默认值； 1-管理方轮询； 2-管理方画面合成；
main_stream	int	是否录主格式码流（视频+音频） 0-否； 1-是；
dual_stream	int	是否录双流 0-否； 1-是；
publish_mode	int	发布类型 0-不发布； 1-发布；
watermark	int	是否添加水印 0-不添加水印； 1-添加水印；
current_progress	int	当前录像进度, 单位为: 秒
members	array	获取录像终端数组
mt_id	str	终端id, 仅当开启终端录像需要最大字符长度：48个字节

参数名称	数据类型	说明
success	int	是否成功
hdus	array	电视墙列表
hdu_id	str	电视墙id 最大字符长度：48个字节
hdu_name	str	电视墙名称最大字符长度：16个字节
occupy	int	是否被占用 0-否； 1-是；
online	int	是否在线 0-否； 1-是；

参数名称	数据类型	说明
success	int	是否成功
hdupolls	array	批量轮询数组
hdupoll_id	str	批量轮询id, 最大字符长度：48个字节

参数名称	数据类型	说明
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	是否成功
secvideo_streams	array	终端双流视频源数组
resolutions	array	分辨率列表
height	str	高度
width	str	宽度
video_streams	array	终端主流视频源数组
resolutions	array	分辨率列表
height	str	高度
width	str	宽度

参数名称	数据类型	说明
http_status	int	http状态码,201创建成功
header	header	头信息
Location	header	用来取消订阅的url
Link.layer	str	用来切层的url
Link.server-sent-events	str	用来创建server-to-client事件流推送的url
body	str	返回体，服务器根据客户端offer返回的answer sdp，根据answer设置RemoteDescription

参数名称	数据类型	说明
http_status	int	http状态码,200创建成功
event	str	事件类型
data	str	JSON数组，层信息

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