| 名称 | 创建会议 |
|---|---|
| URI | /api/v1/mc/confs |
| 方法 | 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查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str | 会议下参 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| conf_type | int | 会议类型,枚举: 0-传统; 1-端口; 2-SFU纯转发会议; 4-auto; 自动会议类型规则: 一.终端支持包含RTC或不包含RTC: - 用户域有端口权限并且机房能力支持端口混合能力,开端口混合会议,机房不支持端口混合能力则优先传统混合会议,没有端口权限则开传统/传统混合会议 二.终端只支持RTC: 1.用户域有SFU权限,没有端口权限,机房支持传统混合能力则开传统混合会议,不支持则开SFU纯转发会议 2.用户域有SFU权限,有端口权限,机房支持端口混合能力,则开端口混合会议,不支持则优先开传统混合会议,机房不支持端口混合和传统混合能力则开SFU纯转发会议 3.用户域没有SFU权限,则返回错误码 |
是 | 0 |
| name | str | 会议名称 | 是 | xxx的会议 |
| 名称 | 结束会议 |
|---|---|
| URI | /api/v1/mc/confs/{conf_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 | 会议e164号(7.0做过兼容,可传meetingMoid,通过长度判断) | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 |
| 名称 | 获取会议列表 |
|---|---|
| URI | /api/v1/mc/meetings |
| 方法 | GET |
| 说明 | |
| 最低支持版本 | 2 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| state | str | 议状态:1:预约,2:开始,3:结束,6:待审批,7:审批不通过, 不传返回所有 | 否 | |
| end_time | str | 结束时间,格式为ISO8601:2000标准,不填表示从开始时间以后的所有 | 否 | |
| start_time | str | 开始时间,格式为ISO8601:2000标准,不填表示从服务器当前时间开始 | 否 | |
| start | int | 默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | 0 |
| count | int | 默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有 | 否 | 0 |
| order | int | 以会议的开始时间为准,默认为0,正序 | 否 | 0 |
| 名称 | 获取会议信息 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_id} |
| 方法 | GET |
| 说明 | |
| 最低支持版本 | 2 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 会议moid [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 预约视频会议 |
|---|---|
| URI | /api/v1/mc/booked_confs |
| 方法 | 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查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| name | str | 会议名称, 1.字符限制: a.不支持输入特殊字符:% & * ^ ~ ' " " ? / \ < > | ` " $ b.且首字符和尾字符不支持输入,下划线(_) 减号(-) 小数点(.) @ (除首尾字符可以输入) 2.最大字符长度:64个字节 |
是 | 传统会议 |
| start_time | str | 会议开始时间,格式为ISO8601:2000标准 | 是 | 2026-03-31T15:42:40+08:00 |
| conf_type | int | 会议类型,枚举: 0-传统; 1-端口; 2-SFU纯转发会议; 4-auto; 自动会议类型规则: 一.终端支持包含RTC或不包含RTC: - 用户域有端口权限并且机房能力支持端口混合能力,开端口混合会议,机房不支持端口混合能力则优先传统混合会议,没有端口权限则开传统/传统混合会议 二.终端只支持RTC: 1.用户域有SFU权限,没有端口权限,机房支持传统混合能力则开传统混合会议,不支持则开SFU纯转发会议 2.用户域有SFU权限,有端口权限,机房支持端口混合能力,则开端口混合会议,不支持则优先开传统混合会议,机房不支持端口混合和传统混合能力则开SFU纯转发会议 3.用户域没有SFU权限,则返回错误码 |
是 | 0 |
| voice_activity_detection | int | 是否开启语言激励 0-不开启; 1-开启; |
是 | 0 |
| max_join_mt | int | 最大与会终端数,默认为192 192-大型192方会议; |
是 | 192 |
| 名称 | 更新预约会议 |
|---|---|
| URI | /api/v1/mc/booked_confs/{conf_id} |
| 方法 | 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 | 会议e164 [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| name | str | 会议名称, 1.字符限制: a.不支持输入特殊字符:% & * ^ ~ ' " " ? / \ < > | ` " $ b.且首字符和尾字符不支持输入,下划线(_) 减号(-) 小数点(.) @ (除首尾字符可以输入) 2.最大字符长度:64个字节 |
是 | 传统会议 |
| start_time | str | 会议开始时间,格式为ISO8601:2000标准 | 是 | 2026-03-31T15:42:40+08:00 |
| conf_type | int | 会议类型,枚举: 0-传统; 1-端口; 2-SFU纯转发会议; 4-auto; 自动会议类型规则: 一.终端支持包含RTC或不包含RTC: - 用户域有端口权限并且机房能力支持端口混合能力,开端口混合会议,机房不支持端口混合能力则优先传统混合会议,没有端口权限则开传统/传统混合会议 二.终端只支持RTC: 1.用户域有SFU权限,没有端口权限,机房支持传统混合能力则开传统混合会议,不支持则开SFU纯转发会议 2.用户域有SFU权限,有端口权限,机房支持端口混合能力,则开端口混合会议,不支持则优先开传统混合会议,机房不支持端口混合和传统混合能力则开SFU纯转发会议 3.用户域没有SFU权限,则返回错误码 |
是 | 0 |
| voice_activity_detection | int | 是否开启语言激励 0-不开启; 1-开启; |
是 | 0 |
| max_join_mt | int | 最大与会终端数,默认为192 192-大型192方会议; |
是 | 192 |
| 名称 | 取消预约会议 |
|---|---|
| URI | /api/v1/mc/booked_confs/{conf_id} |
| 方法 | 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 | 会议e164 [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 | ||
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| reason | str | 取消原因 | 否 |
| 名称 | 获取预约会议列表 |
|---|---|
| URI | /api/v1/mc/booked_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 | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| end_time | str | 结束时间,格式为ISO8601:2000标准,不填表示从开始时间以后的所有 | 否 | |
| start_time | str | 开始时间,格式为ISO8601:2000标准,不填表示从服务器当前时间开始 | 否 | |
| start | int | 默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | 0 |
| count | int | 默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有 | 否 | 0 |
| order | int | 以会议的开始时间为准,默认为0,正序 | 否 | 0 |
| 名称 | 获取预约会议信息 |
|---|---|
| URI | /api/v1/mc/booked_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 | 会议e164 [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 获取会议的观众席人员 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 会议moid [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | 0 |
| count | int | 默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有 | 否 | 0 |
| order | int | 以会议的开始时间为准,默认为0,正序 | 否 | 0 |
| 名称 | 获取会议的与会人员 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_id}/members |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 会议moid [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | 0 |
| count | int | 默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有 | 否 | 0 |
| order | int | 以会议的开始时间为准,默认为0,正序 | 否 | 0 |
| 名称 | 获取会议分享链接 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_id}/link |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 会议moid,兼容虚拟会议室分享,可支持传e164号 [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 会议名称校验 |
|---|---|
| URI | /api/v1/mc/valid_conf_name |
| 方法 | 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查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| meeting_id | str | 会议moid,更新会议时必填 | 否 | |
| conf_name | str | 会议名称 | 是 | |
| end_time | str | 结束时间,格式为ISO8601:2000标准,不填表示从开始时间以后的所有 | 否 | |
| start_time | str | 开始时间,格式为ISO8601:2000标准,不填表示从服务器当前时间开始 | 否 |
| 名称 | 获取会议混音预案信息列表 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_id}/premixs |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | 0 |
| count | int | 默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有 | 否 | 0 |
| order | int | 以会议的开始时间为准,默认为0,正序 | 否 | 0 |
| 名称 | 获取会议混音预案信息 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_id}/premixs/{mix_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key | 否 | |
| mix_id | str | 预案id [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 保存混音预案 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_moid}/premixs |
| 方法 | POST |
| 说明 | |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_moid | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| mode | int | 混音模式 1-智能混音; 2-定制混音; |
是 | 1 |
| 名称 | 修改混音预案 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_moid}/premixs/{mix_id} |
| 方法 | POST |
| 说明 | |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_moid | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key | 否 | |
| mix_id | str | mix_id [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| mode | int | 混音模式 1-智能混音; 2-定制混音; |
是 | 1 |
| 名称 | 删除混音预案 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_moid}/premixs/{mix_id} |
| 方法 | DELETE |
| 说明 | |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_moid | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key | 否 | |
| mix_id | str | 画面合成id | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 |
| 名称 | 获取会议轮询预案信息列表 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_id}/prepolls |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | 0 |
| count | int | 默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有 | 否 | 0 |
| order | int | 以会议的开始时间为准,默认为0,正序 | 否 | 0 |
| 名称 | 获取会议轮询预案信息 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_id}/prepolls/{poll_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key [Path参数] | 否 | |
| poll_id | str | 预案id [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 保存轮询预案 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_moid}/prepolls |
| 方法 | POST |
| 说明 | |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_moid | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
| keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
| mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
| members | array | 轮询成员 | 是 | |
|     conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|     account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|     account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
| 名称 | 修改轮询预案 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_moid}/prepolls/{poll_id} |
| 方法 | POST |
| 说明 | |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_moid | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key | 否 | |
| poll_id | str | poll_id [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
| keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
| mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
| members | array | 轮询成员 | 是 | |
|     conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|     account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|     account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
| 名称 | 删除轮询预案 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_moid}/prepolls/{poll_id} |
| 方法 | DELETE |
| 说明 | |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_moid | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key | 否 | |
| poll_id | str | 轮询id | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 |
| 名称 | 获取会议电视墙预案信息列表 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_id}/pretvwalls |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | 0 |
| count | int | 默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有 | 否 | 0 |
| order | int | 以会议的开始时间为准,默认为0,正序 | 否 | 0 |
| 名称 | 获取会议电视墙预案信息 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_id}/pretvwalls/{tvwall_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key [Path参数] | 否 | |
| tvwall_id | str | 预案id [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 保存电视墙预案 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_moid}/pretvwalls |
| 方法 | POST |
| 说明 | |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_moid | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| name | str | 预案名称 | 否 | |
| tvwalls | array | 电视墙列表 | 否 | |
|     style_id | str | 电视墙风格moid | 是 | |
|     mode | int | 电视墙模式 1-定制画面; 2-批量轮询; |
是 | 1 |
|     show_mt_name | int | 是否显示终端名称 | 否 | 1 |
|     batch_poll | object | 批量轮询 | 否 | |
|         name | str | 预案名称 | 否 | |
|         num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|         keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|         mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|         members | array | 轮询成员 | 是 | |
|             name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|             conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|             account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|             account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|     members | array | 电视墙成员 | 否 | |
|         name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|         hdu_id | str | 设备id号_通道索引号 | 是 | 2_1 |
|         conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|         account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|         member_type | int | 跟随类型 1-会控指定; 2-发言人跟随; 3-管理方跟随; 4-会议轮询跟随; 5-单通道轮询; 6-选看画面合成; 7-批量轮询(仅返回数据时使用); 8-自主多画面; 9-四分屏; 10-内容共享跟随; |
否 | 5 |
|         account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|         mt_chn_idx | int | 终端通道 id | 否 | 2 |
|         poll | object | 单通道轮询 | 否 | |
|             name | str | 预案名称 | 否 | |
|             num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|             keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|             mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|             members | array | 轮询成员 | 是 | |
|                 name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                 conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                 account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                 account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|         vmp | object | 自主多画面 | 否 | |
|             background_image | str | 合成宣讲背景图片id | 否 | |
|             name | str | 预案名称 | 否 | |
|             preferred_style | int | 合成风格偏好 0-经典; 1-一大多小; 2-等大; |
否 | 1 |
|             background_image_enable | int | 合成宣讲背景图片是否开启 0-关闭; 1-开启; |
否 | 0 |
|             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列); |
是 | 5 |
|             mode | int | 画面合成模式 1-定制画面合成; 2-自动画面合成; 3-自动画面合成批量轮询(预留); 4-定制画面合成批量轮询; |
是 | 2 |
|             except_self | int | 是否开启自动画面合成n-1模式,默认为0,即不显示自己的画面,仅自动画面合成时有效 | 否 | 0 |
|             voice_hint | int | 是否识别声音来源 0-否; 1-是; |
是 | 1 |
|             show_mt_name | int | 是否显示别名 0-否; 1-是; |
是 | 1 |
|             broadcast | int | 是否向终端广播 0-否; 1-是; |
是 | 1 |
|             mt_name_style | object | 画面合成参数 | 否 | |
|                 font_color | str | 台标字体三原色#RGB格式,十六进制表示,默认为#FFFFFF | 是 | #FFFFFF |
|                 position | int | 台标显示位置,默认为1 0-左上角; 1-左下角; 2-右上角; 3-右下角; 4-底部中间; |
是 | 1 |
|                 font_size | int | 台标字体大小 0-小; 1-中; 2-大; |
是 | 1 |
|             poll | object | 批量轮询 | 否 | |
|                 name | str | 预案名称 | 否 | |
|                 num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|                 keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|                 mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|                 members | array | 轮询成员 | 是 | |
|                     name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                     conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                     account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                     account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|             members | array | 画面合成成员 | 是 | |
|                 name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                 conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                 account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                 member_type | int | 跟随类型 1-会控指定; 2-发言人跟随; 3-管理方跟随; 4-会议轮询跟随; 6-单通道轮询; 7-内容共享跟随; |
是 | 6 |
|                 chn_idx | int | 在画面合成中的位置 | 是 | 0 |
|                 account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|                 mt_chn_idx | int | 终端通道 id | 否 | 2 |
|                 poll | object | 单通道轮询设置 | 否 | |
|                     name | str | 预案名称 | 否 | |
|                     num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|                     keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|                     mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|                     members | array | 轮询成员 | 是 | |
|                         name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                         conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                         account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                         account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|         spilt | array | 四分屏成员 | 否 | |
|             name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|             conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|             account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|             sub_chn_index | int | 四分屏索引 | 否 | 2 |
|             account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|             mt_chn_idx | int | 终端通道 id | 否 | 2 |
| 名称 | 修改电视墙预案 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_moid}/pretvwalls/{tvwall_id} |
| 方法 | POST |
| 说明 | |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_moid | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key | 否 | |
| tvwall_id | str | tvwall_id [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| name | str | 预案名称 | 否 | |
| tvwalls | array | 电视墙列表 | 否 | |
|     style_id | str | 电视墙风格moid | 是 | |
|     mode | int | 电视墙模式 1-定制画面; 2-批量轮询; |
是 | 1 |
|     show_mt_name | int | 是否显示终端名称 | 否 | 1 |
|     batch_poll | object | 批量轮询 | 否 | |
|         name | str | 预案名称 | 否 | |
|         num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|         keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|         mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|         members | array | 轮询成员 | 是 | |
|             name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|             conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|             account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|             account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|     members | array | 电视墙成员 | 否 | |
|         name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|         hdu_id | str | 设备id号_通道索引号 | 是 | 2_1 |
|         conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|         account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|         member_type | int | 跟随类型 1-会控指定; 2-发言人跟随; 3-管理方跟随; 4-会议轮询跟随; 5-单通道轮询; 6-选看画面合成; 7-批量轮询(仅返回数据时使用); 8-自主多画面; 9-四分屏; 10-内容共享跟随; |
否 | 5 |
|         account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|         mt_chn_idx | int | 终端通道 id | 否 | 2 |
|         poll | object | 单通道轮询 | 否 | |
|             name | str | 预案名称 | 否 | |
|             num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|             keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|             mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|             members | array | 轮询成员 | 是 | |
|                 name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                 conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                 account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                 account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|         vmp | object | 自主多画面 | 否 | |
|             background_image | str | 合成宣讲背景图片id | 否 | |
|             name | str | 预案名称 | 否 | |
|             preferred_style | int | 合成风格偏好 0-经典; 1-一大多小; 2-等大; |
否 | 1 |
|             background_image_enable | int | 合成宣讲背景图片是否开启 0-关闭; 1-开启; |
否 | 0 |
|             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列); |
是 | 5 |
|             mode | int | 画面合成模式 1-定制画面合成; 2-自动画面合成; 3-自动画面合成批量轮询(预留); 4-定制画面合成批量轮询; |
是 | 2 |
|             except_self | int | 是否开启自动画面合成n-1模式,默认为0,即不显示自己的画面,仅自动画面合成时有效 | 否 | 0 |
|             voice_hint | int | 是否识别声音来源 0-否; 1-是; |
是 | 1 |
|             show_mt_name | int | 是否显示别名 0-否; 1-是; |
是 | 1 |
|             broadcast | int | 是否向终端广播 0-否; 1-是; |
是 | 1 |
|             mt_name_style | object | 画面合成参数 | 否 | |
|                 font_color | str | 台标字体三原色#RGB格式,十六进制表示,默认为#FFFFFF | 是 | #FFFFFF |
|                 position | int | 台标显示位置,默认为1 0-左上角; 1-左下角; 2-右上角; 3-右下角; 4-底部中间; |
是 | 1 |
|                 font_size | int | 台标字体大小 0-小; 1-中; 2-大; |
是 | 1 |
|             poll | object | 批量轮询 | 否 | |
|                 name | str | 预案名称 | 否 | |
|                 num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|                 keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|                 mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|                 members | array | 轮询成员 | 是 | |
|                     name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                     conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                     account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                     account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|             members | array | 画面合成成员 | 是 | |
|                 name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                 conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                 account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                 member_type | int | 跟随类型 1-会控指定; 2-发言人跟随; 3-管理方跟随; 4-会议轮询跟随; 6-单通道轮询; 7-内容共享跟随; |
是 | 6 |
|                 chn_idx | int | 在画面合成中的位置 | 是 | 0 |
|                 account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|                 mt_chn_idx | int | 终端通道 id | 否 | 2 |
|                 poll | object | 单通道轮询设置 | 否 | |
|                     name | str | 预案名称 | 否 | |
|                     num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|                     keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|                     mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|                     members | array | 轮询成员 | 是 | |
|                         name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                         conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                         account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                         account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|         spilt | array | 四分屏成员 | 否 | |
|             name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|             conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|             account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|             sub_chn_index | int | 四分屏索引 | 否 | 2 |
|             account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|             mt_chn_idx | int | 终端通道 id | 否 | 2 |
| 名称 | 删除电视墙预案 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_moid}/pretvwalls/{tvwall_id} |
| 方法 | DELETE |
| 说明 | |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_moid | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key | 否 | |
| tvwall_id | str | 电视墙id | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 |
| 名称 | 获取会议VMP预案信息列表 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_id}/prevmps |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | 0 |
| count | int | 默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有 | 否 | 0 |
| order | int | 以会议的开始时间为准,默认为0,正序 | 否 | 0 |
| 名称 | 获取会议VMP预案信息 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_id}/prevmps/{vmp_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key [Path参数] | 否 | |
| vmp_id | str | 预案id [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 保存画面合成预案 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_moid}/prevmps |
| 方法 | POST |
| 说明 | |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_moid | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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列); |
是 | 5 |
| mode | int | 画面合成模式 1-定制画面合成; 2-自动画面合成; 3-自动画面合成批量轮询(预留); 4-定制画面合成批量轮询; |
是 | 2 |
| voice_hint | int | 是否识别声音来源 0-否; 1-是; |
是 | 1 |
| show_mt_name | int | 是否显示别名 0-否; 1-是; |
是 | 1 |
| broadcast | int | 是否向终端广播 0-否; 1-是; |
是 | 1 |
| members | array | 画面合成成员 | 是 | |
|     conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|     account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|     member_type | int | 跟随类型 1-会控指定; 2-发言人跟随; 3-管理方跟随; 4-会议轮询跟随; 6-单通道轮询; 7-内容共享跟随; |
是 | 6 |
|     chn_idx | int | 在画面合成中的位置 | 是 | 0 |
|     account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
| 名称 | 修改画面合成预案 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_moid}/prevmps/{vmp_id} |
| 方法 | POST |
| 说明 | |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_moid | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key | 否 | |
| vmp_id | str | vmp_id [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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列); |
是 | 5 |
| mode | int | 画面合成模式 1-定制画面合成; 2-自动画面合成; 3-自动画面合成批量轮询(预留); 4-定制画面合成批量轮询; |
是 | 2 |
| voice_hint | int | 是否识别声音来源 0-否; 1-是; |
是 | 1 |
| show_mt_name | int | 是否显示别名 0-否; 1-是; |
是 | 1 |
| broadcast | int | 是否向终端广播 0-否; 1-是; |
是 | 1 |
| members | array | 画面合成成员 | 是 | |
|     conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|     account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|     member_type | int | 跟随类型 1-会控指定; 2-发言人跟随; 3-管理方跟随; 4-会议轮询跟随; 6-单通道轮询; 7-内容共享跟随; |
是 | 6 |
|     chn_idx | int | 在画面合成中的位置 | 是 | 0 |
|     account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
| 名称 | 删除画面合成预案 |
|---|---|
| URI | /api/v1/mc/meetings/{meeting_moid}/prevmps/{vmp_id} |
| 方法 | DELETE |
| 说明 | |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_moid | str | 在会控中表示会议id; 在编辑/预约会议页面中表示缓存的key | 否 | |
| vmp_id | str | 画面合成id | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 |
| 名称 | 获取点对点会议权限信息 |
|---|---|
| URI | /api/v1/mc/meetings/p2p_permission_info |
| 方法 | GET |
| 说明 | 获取点对点会议权限信息 |
| 最低支持版本 | 6 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| callee | str | 被呼方,传终端e164 | 是 | |
| caller | str | 主呼方,传终端e164 | 是 |
| 名称 | 获取预约直播会议列表 |
|---|---|
| URI | /api/v1/mc/lives |
| 方法 | GET |
| 说明 | |
| 最低支持版本 | 5 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| machine_room_moid | str | user_domain_moid、 vrs_moid 和machine_room_moid至少传一个,否则返回空列表 | 否 | |
| vrs_moid | str | vrsmoid | 否 | |
| name | str | 模糊查询会议名称 | 否 | |
| user_domain_moid | str | 用户域moid | 否 | |
| end_time | str | 结束时间,格式为ISO8601:2000标准,不填表示从开始时间以后的所有 | 否 | |
| start_time | str | 开始时间,格式为ISO8601:2000标准,不填表示从服务器当前时间开始 | 否 | |
| start | int | 默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | 0 |
| count | int | 默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有 | 否 | 0 |
| order | int | 以会议的开始时间为准,默认为0,正序 | 否 | 0 |
| 名称 | 创建个人模板 |
|---|---|
| URI | /api/v1/mc/personal_templates |
| 方法 | 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查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| name | str | 会议名称, 1.字符限制: a.不支持输入特殊字符:% & * ^ ~ ' " " ? / \ < > | ` " $ b.且首字符和尾字符不支持输入,下划线(_) 减号(-) 小数点(.) @ (除首尾字符可以输入) 2.最大字符长度:64个字节 |
是 | 传统会议 |
| conf_type | int | 会议类型 0-传统; 1-端口; 2-SFU纯转发会议; |
是 | 0 |
| voice_activity_detection | int | 是否开启语言激励 0-不开启; 1-开启; |
是 | 0 |
| max_join_mt | int | 最大与会终端数,默认为192 192-大型192方会议; |
是 | 192 |
| 名称 | 修改个人模板 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id} |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 个人模板ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| name | str | 会议名称, 1.字符限制: a.不支持输入特殊字符:% & * ^ ~ ' " " ? / \ < > | ` " $ b.且首字符和尾字符不支持输入,下划线(_) 减号(-) 小数点(.) @ (除首尾字符可以输入) 2.最大字符长度:64个字节 |
是 | 传统会议 |
| conf_type | int | 会议类型 0-传统; 1-端口; 2-SFU纯转发会议; |
是 | 0 |
| voice_activity_detection | int | 是否开启语言激励 0-不开启; 1-开启; |
是 | 0 |
| max_join_mt | int | 最大与会终端数,默认为192 192-大型192方会议; |
是 | 192 |
| 名称 | 删除个人模板 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 个人模板id [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 |
| 名称 | 获取个人模板列表 |
|---|---|
| URI | /api/v1/mc/personal_templates |
| 方法 | GET |
| 说明 | return personal_templates |
| 最低支持版本 | 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 个人模板的开始行,默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | |
| e164 | str | 会议号 | 否 | |
| count | int | 获取的个人模板数,默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有个人模板 | 否 | |
| order | int | 排序,默认升序 | 否 | |
| conf_category | int | 请求是否来自vcs,vcs时给1 | 否 |
| 名称 | 获取个人模板详情 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 个人模板id [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 获取简单个人模板详情 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/simple |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 个人模板id [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 获取个人模板参会人员 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/invite_members |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 个人模板id [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 个人模板参会人的开始行,默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 是 | |
| count | int | 获取的个人模板参会人数量,默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有参会人员 | 是 | |
| order | int | 默认升序 | 是 |
| 名称 | 获取个人模板观众席人员 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/audiences |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 个人模板id [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 个人模板观众的开始行,默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 是 | |
| count | int | 获取的个人模板观众数量,默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有观众 | 是 | |
| order | int | 默认升序 | 是 |
| 名称 | 获取个人模板VMP信息 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/vmp |
| 方法 | GET |
| 说明 | 获取个人模板VMP信息 |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 个人模板id [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 个人模板VMP人员开始行,默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | |
| count | int | 获取的个人模板VMP人员数量,默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有VMP人员 | 否 | |
| order | int | 排序,默认升序 | 否 |
| 名称 | 获取个人模板轮询信息 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 个人模板id [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 个人模板轮询人员开始行,默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | |
| count | int | 获取的个人模板轮询人员数量,默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有轮询人员 | 否 | |
| order | int | 排序,默认升序 | 否 |
| 名称 | 获取个人模板混音信息 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/mix |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 个人模板id [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 个人模板的混音人员开始行,默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | |
| count | int | 获取的个人模板混音人员数量,默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有混音人员 | 否 | |
| order | int | 排序,默认升序 | 否 |
| 名称 | 获取个人模板vip |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/vip |
| 方法 | GET |
| 说明 | 获取个人模板vip |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 个人模板id [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 个人模板vip人员开始行,默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | |
| count | int | 获取的个人模板vip人员数量,默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有vip人员 | 否 | |
| order | int | 排序,默认升序 | 否 |
| 名称 | 新增模板VMP预案 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/prevmps |
| 方法 | POST |
| 说明 | 新增模板VMP预案 |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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列); |
是 | 5 |
| mode | int | 画面合成模式 1-定制画面合成; 2-自动画面合成; 3-自动画面合成批量轮询(预留); 4-定制画面合成批量轮询; |
是 | 2 |
| voice_hint | int | 是否识别声音来源 0-否; 1-是; |
是 | 1 |
| show_mt_name | int | 是否显示别名 0-否; 1-是; |
是 | 1 |
| broadcast | int | 是否向终端广播 0-否; 1-是; |
是 | 1 |
| members | array | 画面合成成员 | 是 | |
|     conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|     account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|     member_type | int | 跟随类型 1-会控指定; 2-发言人跟随; 3-管理方跟随; 4-会议轮询跟随; 6-单通道轮询; 7-内容共享跟随; |
是 | 6 |
|     chn_idx | int | 在画面合成中的位置 | 是 | 0 |
|     account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
| 名称 | 修改模板VMP预案 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/prevmps/{vmp_id} |
| 方法 | POST |
| 说明 | 修改模板VMP预案 |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 修改/新增模板页面中表示缓存的key [Path参数] | 是 | |
| vmp_id | str | 画面合成ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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列); |
是 | 5 |
| mode | int | 画面合成模式 1-定制画面合成; 2-自动画面合成; 3-自动画面合成批量轮询(预留); 4-定制画面合成批量轮询; |
是 | 2 |
| voice_hint | int | 是否识别声音来源 0-否; 1-是; |
是 | 1 |
| show_mt_name | int | 是否显示别名 0-否; 1-是; |
是 | 1 |
| broadcast | int | 是否向终端广播 0-否; 1-是; |
是 | 1 |
| members | array | 画面合成成员 | 是 | |
|     conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|     account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|     member_type | int | 跟随类型 1-会控指定; 2-发言人跟随; 3-管理方跟随; 4-会议轮询跟随; 6-单通道轮询; 7-内容共享跟随; |
是 | 6 |
|     chn_idx | int | 在画面合成中的位置 | 是 | 0 |
|     account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
| 名称 | 删除模板VMP预案 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/prevmps/{vmp_id} |
| 方法 | DELETE |
| 说明 | 删除模板VMP预案 |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 | |
| vmp_id | str | 画面合成ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 |
| 名称 | 获取模板VMP预案信息列表 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/prevmps |
| 方法 | GET |
| 说明 | return data |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| count | int | 获取的模板VMP预案数量,默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有VMP预案 | 否 | |
| start | int | 模板VMP预案开始行,默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | |
| order | int | 排序,默认升序 | 否 |
| 名称 | 获取模板VMP预案信息 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/prevmps/{vmp_id} |
| 方法 | GET |
| 说明 | 获取模板VMP预案信息 |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 | |
| vmp_id | str | 画面合成ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 新增模板轮询预案 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/prepolls |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
| keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
| mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
| members | array | 轮询成员 | 是 | |
|     conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|     account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|     account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
| 名称 | 修改模板轮询预案 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/prepolls/{poll_id} |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 修改/新增模板页面中表示缓存的key [Path参数] | 是 | |
| poll_id | str | 轮询ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
| keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
| mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
| members | array | 轮询成员 | 是 | |
|     conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|     account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|     account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
| 名称 | 删除模板轮询预案 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/prepolls/{poll_id} |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 | |
| poll_id | str | 轮询ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 |
| 名称 | 获取模板轮询预案信息列表 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/prepolls |
| 方法 | GET |
| 说明 | return data |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| count | int | 获取的模板轮询预案数量,默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有轮询预案 | 是 | |
| start | int | 模板轮询预案开始行,默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 是 | |
| order | int | 排序,默认升序 | 是 |
| 名称 | 获取模板轮询预案信息 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/prepolls/{poll_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 | |
| poll_id | str | 轮询ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 新增模板混音预案 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/premixs |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| mode | int | 混音模式 1-智能混音; 2-定制混音; |
是 | 1 |
| 名称 | 修改模板混音预案 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/premixs/{mix_id} |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 修改/新增模板页面中表示缓存的key [Path参数] | 是 | |
| mix_id | str | 混音ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| mode | int | 混音模式 1-智能混音; 2-定制混音; |
是 | 1 |
| 名称 | 删除模板混音预案 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/premixs/{mix_id} |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 否 | |
| mix_id | str | 混音预案ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 |
| 名称 | 获取模板混音预案信息列表 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/premixs |
| 方法 | GET |
| 说明 | return data |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| count | int | 获取的模板混音预案数量,默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有混音预案 | 是 | |
| start | int | 模板混音预案开始行,默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 是 | |
| order | int | 排序,默认升序 | 是 |
| 名称 | 获取模板混音预案信息 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/premixs/{mix_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 | |
| mix_id | str | 混音ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 新增模板电视墙预案 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/pretvwalls |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| name | str | 预案名称 | 否 | |
| tvwalls | array | 电视墙列表 | 否 | |
|     style_id | str | 电视墙风格moid | 是 | |
|     mode | int | 电视墙模式 1-定制画面; 2-批量轮询; |
是 | 1 |
|     show_mt_name | int | 是否显示终端名称 | 否 | 1 |
|     batch_poll | object | 批量轮询 | 否 | |
|         name | str | 预案名称 | 否 | |
|         num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|         keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|         mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|         members | array | 轮询成员 | 是 | |
|             name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|             conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|             account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|             account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|     members | array | 电视墙成员 | 否 | |
|         name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|         hdu_id | str | 设备id号_通道索引号 | 是 | 2_1 |
|         conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|         account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|         member_type | int | 跟随类型 1-会控指定; 2-发言人跟随; 3-管理方跟随; 4-会议轮询跟随; 5-单通道轮询; 6-选看画面合成; 7-批量轮询(仅返回数据时使用); 8-自主多画面; 9-四分屏; 10-内容共享跟随; |
否 | 5 |
|         account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|         mt_chn_idx | int | 终端通道 id | 否 | 2 |
|         poll | object | 单通道轮询 | 否 | |
|             name | str | 预案名称 | 否 | |
|             num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|             keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|             mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|             members | array | 轮询成员 | 是 | |
|                 name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                 conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                 account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                 account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|         vmp | object | 自主多画面 | 否 | |
|             background_image | str | 合成宣讲背景图片id | 否 | |
|             name | str | 预案名称 | 否 | |
|             preferred_style | int | 合成风格偏好 0-经典; 1-一大多小; 2-等大; |
否 | 1 |
|             background_image_enable | int | 合成宣讲背景图片是否开启 0-关闭; 1-开启; |
否 | 0 |
|             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列); |
是 | 5 |
|             mode | int | 画面合成模式 1-定制画面合成; 2-自动画面合成; 3-自动画面合成批量轮询(预留); 4-定制画面合成批量轮询; |
是 | 2 |
|             except_self | int | 是否开启自动画面合成n-1模式,默认为0,即不显示自己的画面,仅自动画面合成时有效 | 否 | 0 |
|             voice_hint | int | 是否识别声音来源 0-否; 1-是; |
是 | 1 |
|             show_mt_name | int | 是否显示别名 0-否; 1-是; |
是 | 1 |
|             broadcast | int | 是否向终端广播 0-否; 1-是; |
是 | 1 |
|             mt_name_style | object | 画面合成参数 | 否 | |
|                 font_color | str | 台标字体三原色#RGB格式,十六进制表示,默认为#FFFFFF | 是 | #FFFFFF |
|                 position | int | 台标显示位置,默认为1 0-左上角; 1-左下角; 2-右上角; 3-右下角; 4-底部中间; |
是 | 1 |
|                 font_size | int | 台标字体大小 0-小; 1-中; 2-大; |
是 | 1 |
|             poll | object | 批量轮询 | 否 | |
|                 name | str | 预案名称 | 否 | |
|                 num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|                 keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|                 mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|                 members | array | 轮询成员 | 是 | |
|                     name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                     conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                     account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                     account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|             members | array | 画面合成成员 | 是 | |
|                 name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                 conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                 account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                 member_type | int | 跟随类型 1-会控指定; 2-发言人跟随; 3-管理方跟随; 4-会议轮询跟随; 6-单通道轮询; 7-内容共享跟随; |
是 | 6 |
|                 chn_idx | int | 在画面合成中的位置 | 是 | 0 |
|                 account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|                 mt_chn_idx | int | 终端通道 id | 否 | 2 |
|                 poll | object | 单通道轮询设置 | 否 | |
|                     name | str | 预案名称 | 否 | |
|                     num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|                     keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|                     mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|                     members | array | 轮询成员 | 是 | |
|                         name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                         conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                         account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                         account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|         spilt | array | 四分屏成员 | 否 | |
|             name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|             conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|             account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|             sub_chn_index | int | 四分屏索引 | 否 | 2 |
|             account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|             mt_chn_idx | int | 终端通道 id | 否 | 2 |
| 名称 | 更新模板电视墙预案 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/pretvwalls/{pre_id} |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 修改/新增模板页面中表示缓存的key [Path参数] | 是 | |
| pre_id | str | 电视墙ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| name | str | 预案名称 | 否 | |
| tvwalls | array | 电视墙列表 | 否 | |
|     style_id | str | 电视墙风格moid | 是 | |
|     mode | int | 电视墙模式 1-定制画面; 2-批量轮询; |
是 | 1 |
|     show_mt_name | int | 是否显示终端名称 | 否 | 1 |
|     batch_poll | object | 批量轮询 | 否 | |
|         name | str | 预案名称 | 否 | |
|         num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|         keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|         mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|         members | array | 轮询成员 | 是 | |
|             name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|             conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|             account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|             account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|     members | array | 电视墙成员 | 否 | |
|         name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|         hdu_id | str | 设备id号_通道索引号 | 是 | 2_1 |
|         conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|         account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|         member_type | int | 跟随类型 1-会控指定; 2-发言人跟随; 3-管理方跟随; 4-会议轮询跟随; 5-单通道轮询; 6-选看画面合成; 7-批量轮询(仅返回数据时使用); 8-自主多画面; 9-四分屏; 10-内容共享跟随; |
否 | 5 |
|         account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|         mt_chn_idx | int | 终端通道 id | 否 | 2 |
|         poll | object | 单通道轮询 | 否 | |
|             name | str | 预案名称 | 否 | |
|             num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|             keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|             mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|             members | array | 轮询成员 | 是 | |
|                 name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                 conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                 account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                 account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|         vmp | object | 自主多画面 | 否 | |
|             background_image | str | 合成宣讲背景图片id | 否 | |
|             name | str | 预案名称 | 否 | |
|             preferred_style | int | 合成风格偏好 0-经典; 1-一大多小; 2-等大; |
否 | 1 |
|             background_image_enable | int | 合成宣讲背景图片是否开启 0-关闭; 1-开启; |
否 | 0 |
|             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列); |
是 | 5 |
|             mode | int | 画面合成模式 1-定制画面合成; 2-自动画面合成; 3-自动画面合成批量轮询(预留); 4-定制画面合成批量轮询; |
是 | 2 |
|             except_self | int | 是否开启自动画面合成n-1模式,默认为0,即不显示自己的画面,仅自动画面合成时有效 | 否 | 0 |
|             voice_hint | int | 是否识别声音来源 0-否; 1-是; |
是 | 1 |
|             show_mt_name | int | 是否显示别名 0-否; 1-是; |
是 | 1 |
|             broadcast | int | 是否向终端广播 0-否; 1-是; |
是 | 1 |
|             mt_name_style | object | 画面合成参数 | 否 | |
|                 font_color | str | 台标字体三原色#RGB格式,十六进制表示,默认为#FFFFFF | 是 | #FFFFFF |
|                 position | int | 台标显示位置,默认为1 0-左上角; 1-左下角; 2-右上角; 3-右下角; 4-底部中间; |
是 | 1 |
|                 font_size | int | 台标字体大小 0-小; 1-中; 2-大; |
是 | 1 |
|             poll | object | 批量轮询 | 否 | |
|                 name | str | 预案名称 | 否 | |
|                 num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|                 keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|                 mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|                 members | array | 轮询成员 | 是 | |
|                     name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                     conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                     account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                     account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|             members | array | 画面合成成员 | 是 | |
|                 name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                 conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                 account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                 member_type | int | 跟随类型 1-会控指定; 2-发言人跟随; 3-管理方跟随; 4-会议轮询跟随; 6-单通道轮询; 7-内容共享跟随; |
是 | 6 |
|                 chn_idx | int | 在画面合成中的位置 | 是 | 0 |
|                 account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|                 mt_chn_idx | int | 终端通道 id | 否 | 2 |
|                 poll | object | 单通道轮询设置 | 否 | |
|                     name | str | 预案名称 | 否 | |
|                     num | int | 轮询次数,0表示无限次轮询 | 是 | 10 |
|                     keep_time | int | 轮询间隔时间(秒) | 是 | 5 |
|                     mode | int | 轮询模式 1-视频轮询; 3-音视频轮询; |
是 | 1 |
|                     members | array | 轮询成员 | 是 | |
|                         name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|                         conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|                         account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|                         account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|         spilt | array | 四分屏成员 | 否 | |
|             name | str | 名称,最大字符长度:128个字节 | 否 | 我是xxx |
|             conf_e164 | str | 所属会议e164号,级联会议时为本级会议e164号 | 是 | 000001 |
|             account | str | 帐号,最大字符长度:128个字节 | 是 | c69da1ef-5930-47e0-9a79-dfa083de0208 |
|             sub_chn_index | int | 四分屏索引 | 否 | 2 |
|             account_type | int | 帐号类型 1-moid; 4-非系统邮箱; 5-e164号; 6-电话; 7-ip地址; 8-别名@ip(监控前端); |
是 | 1 |
|             mt_chn_idx | int | 终端通道 id | 否 | 2 |
| 名称 | 删除模板电视墙预案 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/pretvwalls/{pre_id} |
| 方法 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 | |
| pre_id | str | 电视墙ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 |
| 名称 | 获取模板电视墙预案列表 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/pretvwalls |
| 方法 | GET |
| 说明 | return data |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| count | int | 获取的模板电视墙预案数量,默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有电视墙预案 | 是 | |
| start | int | 模板电视墙预案开始行,默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 是 | |
| order | int | 排序,默认升序 | 是 |
| 名称 | 获取模板电视墙预案详情 |
|---|---|
| URI | /api/v1/mc/personal_templates/{template_id}/pretvwalls/{pre_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| template_id | str | 在会控中表示个人模板id; 在修改/新增模板页面中表示缓存的key [Path参数] | 是 | |
| pre_id | str | 电视墙模板ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 获取电视墙风格列表 |
|---|---|
| URI | /api/v1/mc/tvwall_styles |
| 方法 | 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查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| start | int | 默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据 | 否 | 0 |
| count | int | 默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有 | 否 | 0 |
| order | int | 以风格创建时间排序; 0: 正序; 1:倒序 | 否 | 0 |
| 名称 | 获取电视墙风格详情 |
|---|---|
| URI | /api/v1/mc/tvwall_styles/{style_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| style_id | str | 风格id [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| status | int | 是否获取通道实时信息 | 否 |
| 名称 | 上传会议文件 |
|---|---|
| URI | /api/v1/mc/meeting_files/{meeting_id} |
| 方法 | POST |
| 说明 | 上传会议文件,一次只能上传一个文件,每个文件不超过20MB,一个会议最多保存10个文件 |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 会议moid,预约会议时传 meetingKey [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| file | File | 文件 | 否 |
| 名称 | 删除会议文件 |
|---|---|
| URI | /api/v1/mc/meeting_files/{file_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| file_id | str | 文件id [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 |
| 名称 | 获取会议文件列表 |
|---|---|
| URI | /api/v1/mc/meeting_files/{meeting_id} |
| 方法 | GET |
| 说明 | 获取会议文件列表,meeting_id是会议moid,文件7天后自动删除, |
| 最低支持版本 | 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_id | str | 会议moid,预约会议时传 meetingKey [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 上传背景图片 |
|---|---|
| URI | /api/v1/mc/background_images |
| 方法 | POST |
| 说明 | 背景图片支持上传图片格式为jpg、jpeg,名称长度不超过15个字符,图片大小不超过5M,建议上传尺寸为:3840*2160、1920*1080,可批量上传 |
| 最低支持版本 | 11 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| files | str | 图片文件,该参数需要配合request的content-type改为multipart/form-data一起使用 | 否 |
| 名称 | 获取背景图片列表 |
|---|---|
| URI | /api/v1/mc/background_images |
| 方法 | GET |
| 说明 | |
| 最低支持版本 | 11 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 预览单个背景图片 |
|---|---|
| URI | /api/v1/mc/background_images/{file_id}/preview |
| 方法 | GET |
| 说明 | |
| 最低支持版本 | 11 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| file_id | str | 图片id [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 获取单个背景图片详情 |
|---|---|
| URI | /api/v1/mc/background_images/{file_id} |
| 方法 | GET |
| 说明 | |
| 最低支持版本 | 11 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| file_id | str | 图片id [Path参数] | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 删除背景图片 |
|---|---|
| URI | /api/v1/mc/background_images |
| 方法 | DELETE |
| 说明 | |
| 最低支持版本 | 11 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 | ||
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| file_ids | array | 图片ids | 否 | |
|     str | str | 字符 | 否 |
| 名称 | 保存例会 |
|---|---|
| URI | /api/v1/mc/regular_meeting |
| 方法 | POST |
| 说明 | |
| 最低支持版本 | 6 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| name | str | 会议名称, 1.字符限制: a.不支持输入特殊字符:% & * ^ ~ ' " " ? / \ < > | ` " $ b.且首字符和尾字符不支持输入,下划线(_) 减号(-) 小数点(.) @ (除首尾字符可以输入) 2.最大字符长度:64个字节 |
是 | 传统会议 |
| start_time | str | 会议开始时间,格式为ISO8601:2000标准 | 是 | 2026-03-31T15:42:41+08:00 |
| conf_type | int | 会议类型,枚举: 0-传统; 1-端口; 2-SFU纯转发会议; 4-auto; 自动会议类型规则: 一.终端支持包含RTC或不包含RTC: - 用户域有端口权限并且机房能力支持端口混合能力,开端口混合会议,机房不支持端口混合能力则优先传统混合会议,没有端口权限则开传统/传统混合会议 二.终端只支持RTC: 1.用户域有SFU权限,没有端口权限,机房支持传统混合能力则开传统混合会议,不支持则开SFU纯转发会议 2.用户域有SFU权限,有端口权限,机房支持端口混合能力,则开端口混合会议,不支持则优先开传统混合会议,机房不支持端口混合和传统混合能力则开SFU纯转发会议 3.用户域没有SFU权限,则返回错误码 |
是 | 0 |
| voice_activity_detection | int | 是否开启语言激励 0-不开启; 1-开启; |
是 | 0 |
| max_join_mt | int | 最大与会终端数,默认为192 192-大型192方会议; |
是 | 192 |
| 名称 | 修改例会 |
|---|---|
| URI | /api/v1/mc/regular_meeting/{regular_meeting_moid} |
| 方法 | POST |
| 说明 | |
| 最低支持版本 | 6 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| regular_meeting_moid | str | 例会moid | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| name | str | 会议名称, 1.字符限制: a.不支持输入特殊字符:% & * ^ ~ ' " " ? / \ < > | ` " $ b.且首字符和尾字符不支持输入,下划线(_) 减号(-) 小数点(.) @ (除首尾字符可以输入) 2.最大字符长度:64个字节 |
是 | 传统会议 |
| start_time | str | 会议开始时间,格式为ISO8601:2000标准 | 是 | 2026-03-31T15:42:41+08:00 |
| conf_type | int | 会议类型,枚举: 0-传统; 1-端口; 2-SFU纯转发会议; 4-auto; 自动会议类型规则: 一.终端支持包含RTC或不包含RTC: - 用户域有端口权限并且机房能力支持端口混合能力,开端口混合会议,机房不支持端口混合能力则优先传统混合会议,没有端口权限则开传统/传统混合会议 二.终端只支持RTC: 1.用户域有SFU权限,没有端口权限,机房支持传统混合能力则开传统混合会议,不支持则开SFU纯转发会议 2.用户域有SFU权限,有端口权限,机房支持端口混合能力,则开端口混合会议,不支持则优先开传统混合会议,机房不支持端口混合和传统混合能力则开SFU纯转发会议 3.用户域没有SFU权限,则返回错误码 |
是 | 0 |
| voice_activity_detection | int | 是否开启语言激励 0-不开启; 1-开启; |
是 | 0 |
| max_join_mt | int | 最大与会终端数,默认为192 192-大型192方会议; |
是 | 192 |
| 名称 | 取消例会(批量) |
|---|---|
| URI | /api/v1/mc/regular_meeting/{regular_meeting_moid} |
| 方法 | DELETE |
| 说明 | |
| 最低支持版本 | 6 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| regular_meeting_moid | str | 例会moid | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 | ||
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| meeting_moids | str | 被取消的会议moid | 否 | args,args |
| reason | str | 取消原因 | 否 |
| 名称 | 查看例会信息 |
|---|---|
| URI | /api/v1/mc/regular_meeting/{regular_meeting_moid} |
| 方法 | GET |
| 说明 | |
| 最低支持版本 | 6 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| regular_meeting_moid | str | 例会moid | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 获取例会日期 |
|---|---|
| URI | /api/v1/mc/regular_meeting/{regular_meeting_moid}/date |
| 方法 | GET |
| 说明 | |
| 最低支持版本 | 6 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| regular_meeting_moid | str | 例会moid | 否 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 获取当前用户所在企业的预订期限 |
|---|---|
| URI | /api/v1/mc/deadline |
| 方法 | GET |
| 说明 | |
| 最低支持版本 | 5 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 获取会管API版本信息 |
|---|---|
| URI | /api/v1/mc/version |
| 方法 | 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 获取缺省模板信息 |
|---|---|
| URI | /api/v1/mc/default_template |
| 方法 | GET |
| 说明 | |
| 最低支持版本 | 10 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 设置缺省模板 |
|---|---|
| URI | /api/v1/mc/default_template |
| 方法 | POST |
| 说明 | |
| 最低支持版本 | 10 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| e164 | str | 模板e164号 | 否 | |
| template_moid | str | 模板moid | 否 | |
| name | str | 模板名称 | 否 |
| 名称 | 删除缺省模板 |
|---|---|
| URI | /api/v1/mc/default_template |
| 方法 | DELETE |
| 说明 | |
| 最低支持版本 | 10 |
请求头说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 |
| 名称 | 创建虚拟会议室 |
|---|---|
| URI | /api/v1/mc/virtual_meeting_rooms |
| 方法 | POST |
| 说明 | 创建虚拟会议室,参数中非必填项默认值为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查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| name | str | 虚拟会议室名称, 1.字符限制: a.不支持输入特殊字符:% & * ^ ~ ' " " ? / \ < > | ` " $ b.且首字符和尾字符不支持输入,下划线(_) 减号(-) 小数点(.) @ (除首尾字符可以输入) 2.最大字符长度:64个字节 |
是 | 1 |
| preoccupy_resource | int | 预占资源模式(创会时就预占音视频适配器),如会议类型为SFU则为纯转发 0-不预占模式; 1-预占模式; 2-SFU纯转发模式; |
是 | 0 |
| video_formats | array | 虚拟会议室主视频格式列表 | 是 | |
|     bitrate | int | 主流码率,默认为2048 | 是 | 2048 |
|     resolution | int | 主流视频分辨率,默认为13 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k; |
是 | 13 |
|     format | int | 主流视频格式,默认为3 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+; |
是 | 3 |
|     frame | int | 主流帧率,默认为30 | 是 | 30 |
| 名称 | 修改虚拟会议室 |
|---|---|
| URI | /api/v1/mc/virtual_meeting_rooms/{vmr_id} |
| 方法 | POST |
| 说明 | 修改虚拟会议室,参数中非必填项默认值为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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| vmr_id | str | 虚拟会议室ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| params | str(object) | 请求内容,以JSON形式发送,需进行UrlEncode,全量更新,需传所有参数 | 否 |
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| name | str | 虚拟会议室名称, 1.字符限制: a.不支持输入特殊字符:% & * ^ ~ ' " " ? / \ < > | ` " $ b.且首字符和尾字符不支持输入,下划线(_) 减号(-) 小数点(.) @ (除首尾字符可以输入) 2.最大字符长度:64个字节 |
是 | 1 |
| preoccupy_resource | int | 预占资源模式(创会时就预占音视频适配器),如会议类型为SFU则为纯转发 0-不预占模式; 1-预占模式; 2-SFU纯转发模式; |
是 | 0 |
| video_formats | array | 虚拟会议室主视频格式列表 | 是 | |
|     bitrate | int | 主流码率,默认为2048 | 是 | 2048 |
|     resolution | int | 主流视频分辨率,默认为13 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k; |
是 | 13 |
|     format | int | 主流视频格式,默认为3 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+; |
是 | 3 |
|     frame | int | 主流帧率,默认为30 | 是 | 30 |
| 名称 | 删除虚拟会议室 |
|---|---|
| URI | /api/v1/mc/virtual_meeting_rooms/{vmr_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| vmr_id | str | 会议室ID [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| _method | 若浏览器不支持DELETE,则使用POST请求,并在请求参数中带上_method参数,并设置其值为DELETE,作为不支持DELETE请求的替代方案。 | 否 |
| 名称 | 获取虚拟会议室列表 |
|---|---|
| URI | /api/v1/mc/virtual_meeting_rooms |
| 方法 | GET |
| 说明 | return virtual_meeting_rooms |
| 最低支持版本 | 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 | |
| e164 | str | 会议164号,空值则查询所有记录 | 否 | |
| count | int | 每页条数,默认每页10条记录 | 否 | |
| order | int | 排序,默认升序 | 否 | |
| start | int | 起始记录序号,默认从第一条开始 | 否 |
| 名称 | 获取虚拟会议室详情 |
|---|---|
| URI | /api/v1/mc/virtual_meeting_rooms/{vmr_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路径参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| vmr_id | str | 虚拟会议室id [Path参数] | 是 |
URL查询参数说明
| 参数名称 | 数据类型 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|---|
| account_token | str | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 获取资源占用情况 |
|---|---|
| URI | /api/v1/mc/resources |
| 方法 | 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 |
| 名称 | 获取当前用户域可以使用的会议平台 |
|---|---|
| URI | /api/v1/mc/platforms |
| 方法 | 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 | 软件权限token,通过oauth登录获取到的授权码 | 是 |