企业预约新的会议,用于预约、管理会议日程。邀请终端参加特定主题会议,并支持设置自动录制、自动呼叫预约终端等功能。(推荐使用新版本预约会议api)
默认接口请求频率限制:20次/秒。
REST URL
POST https://sdk.xylink.com/api/rest/external/{version}/meetingreminders?enterpriseId=XXX&meetingLock=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 是否必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | 3.9 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | 3.9 |
signature | String | Query | 签名鉴权2.0:否 | 无 | API签名,参见签名规则 | 3.9 |
meetingLock | boolean | Query | 否 | false | 会议是否锁定(如果是true,那么会议将在开始时锁定,主动入会仅限预约会议参会者列表人员) | 3.9 |
title | String | Body | 是 | 无 | 会议标题 非法参数提示: 无效的title(空值) | 3.9 |
startTime | long | Body | 是 | 无 | 会议开始时间Unix毫秒时间戳 (开始时间不得大于等于结束时间) | 3.9 |
endTime | long | Body | 是 | 无 | 会议结束时间Unix毫秒时间戳 | 3.9 |
participants | List | Body | 否 | 无 | 参加会议的参会者列表(软终端为手机号/ 硬终端为设备号) | 3.9 |
meetingHost | List | Body | 否 | 无 | 会议主持人集合(主持人必须在参会者中,且主持人最多不超过3个,硬终端为设备号且只支持以下型号AE350,AE380,NE90;软终端为手机号) | 3.9 |
address | String | Body | 否 | 无 | 会议地址 | 3.9 |
details | String | Body | 否 | 无 | 会议描述 | 3.9 |
autoInvite | int | Body | 否 | 0 | 开会时,是否自动呼叫小鱼终端入会。0:不自动呼叫,为默认值;1:自动呼叫 | 3.9 |
meetingRoomType | int | Body | 是 | 无 | 预约类型(1.使用随机会议室号,由小鱼系统随机创建,但是如果同时指定了会议室号码则会优先使用指定的会议室号码;2使用指定会议室号) | 3.9 |
conferenceNumber | String | Body | 是 | 无 | 会议室号(仅在meetingRoomType为2时生效) | 3.9 |
autoRecord | int | Body | 否 | 0 | 自动录制,0: 不自动录制;1:自动录制 | 3.9 |
enableOffLineRecord | int | Body | 否 | 无 | 是否开启离线录制,0 :实时转码录制;1:离线转码录制 | 3.9 |
offlineTranscodePriority | String | Body | 否 | 无 | 离线转码优先级(high,normal) | 3.9 |
lineRateMin | int | Body | 否 | 无 | 云会议室会议速率选项,最低带宽 可选值: -1|128|192|256|320|384|512|768|832|1024|1152|1280|1472|1536|1728|1920|2048|2560|3072|3584|4096 | 3.9 |
lineRateMax | int | Body | 否 | 无 | 云会议室会议速率选项,最高带宽 可选值: -1|128|192|256|320|384|512|768|832|1024|1152|1280|1472|1536|1728|1920|2048|2560|3072|3584|4096 | 3.9 |
meetingSponsor | String | Body | 否 | 无 | 会议预约人 | 5.2 |
mainImage | String | Body | 否 | 无 | 主画面设备 | 3.9 |
recordViewLayout | Json | Body | 否 | 无 | 会议录制布局 | 3.9 |
└ mainLayout | Json | Body | 否 | 无 | 会议主录制布局 | 3.9 |
└ extrasLayout | Json | Body | 否 | 无 | 会议多路录制布局,需要对云会议室申请权限,最多限制5路 | 3.9 |
└ layout | -- | Body | 否 | 无 | 画面布局配置 | 3.9 |
└ screen | String | Body | 否 | 无 | 横竖屏类型,可选值"landscape"(横屏),"portrait"(竖屏) | 3.9 |
└ people | -- | Body | 否 | 无 | 只有people情况下的布局配置 | 3.9 |
└ maxCells | Integer | Body | 否 | 无 | 最大窗口数量,实际参会人数超过maxCells时,只显示maxCells个人 | 3.9 |
└ view | String | Body | 否 | 无 | 布局类型,可选值包括: asymOverlap:非对称叠加; asymTiling:非对称平铺; symTiling:对称平铺 | 3.9 |
└ mode | String | Body | 否 | 无 | 布局模式:"auto"(自动布局:主会场优先) | 3.9 |
└ specified | List | Body | 否 | 无 | 指定画面终端列表,支持手机号、设备号 | 3.9 |
└ content | -- | Body | 否 | 无 | 只有content情况下的布局配置 | 3.9 |
└ maxCells | Integer | Body | 否 | 无 | 最大窗口数量,实际参会人数超过maxCells时,只显示maxCells个人 | 3.9 |
└ view | String | Body | 否 | 无 | 布局类型,可选值: "asymOverlap"(非对称叠加), "asymTiling"(非对称平铺), "symTiling"(对称平铺) | 3.9 |
└ mode | String | Body | 否 | 无 | 布局模式:"auto"(自动布局:主会场优先) | 3.9 |
└ prefer | boolean | Body | 否 | false | 指示是否content(第一分屏)幕显示,可选值:true(#1分屏), false(#2分屏) | 3.9 |
└ OSD | -- | Body | 否 | 无 | 叠加在视频上的附属信息 | 3.9 |
└ nameplate | -- | Body | 否 | 无 | 叠加终端名称 | 3.9 |
└ enabled | boolean | Body | 否 | 无 | 是否启动功能,可选值:true:叠加;false:不叠加 | 3.9 |
autoCreateUsers | List | Body | 否 | 无 | 自动创建账号 | 5.2(2024-0802版本),公有云不支持 |
└ account | String | Body | 否 | 无 | 用户账号 | 5.2(2024-0802版本),公有云不支持 |
└ name | String | Body | 否 | 无 | 用户名称 | 5.2(2024-0802版本),公有云不支持 |
通过预约会议API进行预约时可指定会议的录制布局 ,支持横屏布局或竖屏布局,默认为横屏。 横屏情况下支持以下四种布局类型:
布局类型默认为POP,录制默认最大支持9分屏。 画面布局模式默认按主会场优先的顺序排列,没有主会场的情况下,按语音激励顺序显示,同时平台支持按上图顺序指定各个分屏终端。 当参会者或会场个数大于指定分屏个数时,画面将不会被显示。 对于有内容共享的情况,可设置共享内容画面的分屏顺序为第1分屏或第2分屏,默认为第1分屏,支持按一定间隔时间自动切换。 竖屏模式下,默认为非对称叠加,最大支持3分屏,布局样式如下:
请求消息体示例(Json)
{
"title": "title-test",
"startTime": xxxxxx,
"endTime": xxxxxx,
"conferenceNumber": "xxxxxx",
"address": "address--test",
"details": "details--test",
"autoInvite": 1,
"autoRecord": 1,
"participants": ["xxxxxx", "xxxxxx", "xxxxxx"],
"meetingSponsor": "xxxxxx",
"recordViewLayout":{
"mainLayout": "{\"layout\":{\"screen\":\"landscape\",\"people\":{\"maxCells\":1,\"view\":\"symTiling\",\"mode\":\"auto\",\"specified\":[\"13113567788\"]},\"content\":{\"view\":\"symTiling\",\"mode\":\"auto\",\"prefer\":false}},\"OSD\":{\"nameplate\":{\"enabled\":true}}}",
"extrasLayout": [
"{\"layout\":{\"screen\":\"landscape\",\"people\":{\"mode\":\"auto\",\"view\":\"symTiling\",\"specified\":[\"17610356832\"]},\"content\":{\"mode\":\"auto\",\"view\":\"symTiling\",\"prefer\":false}},\"OSD\":{\"nameplate\":{\"enabled\":true}}}",
"{\"layout\":{\"screen\":\"landscape\",\"people\":{\"mode\":\"auto\",\"view\":\"symTiling\",\"specified\":[\"17610356832\"]},\"content\":{\"mode\":\"auto\",\"view\":\"symTiling\",\"prefer\":false}},\"OSD\":{\"nameplate\":{\"enabled\":true}}}"
]
},
"autoCreateUsers": [
{
"account": "xxx",
"name": "xxx"
}
]
}
常见录制布局示例:(详情请查看画面布局)
录制content大窗,主讲小窗:"{\"layout\":{\"content\":{\"maxCells\":2,\"mode\":\"auto\",\"view\":\"POP\"}}}"
录制content小窗,主讲大窗:"{\"layout\":{\"content\":{\"maxCells\":2,\"prefer\":false,\"mode\":\"auto\",\"view\":\"POP\"}}}"
录制content和主讲自动切换:"{\"layout\":{\"content\":{\"maxCells\":2,\"smart\":true,\"mode\":\"auto\",\"view\":\"POP\"}}}"
只录制content:"{\"layout\":{\"content\":{\"maxCells\":1,\"mode\":\"auto\",\"view\":\"POP\"}}}"
分享content和主讲对称分屏显示:"{\"layout\":{\"content\":{\"maxCells\":2,\"mode\":\"auto\",\"view\":\"symTiling\"}}}"
content存在的情况下,仅录制主讲人:"{\"layout\":{\"content\":{\"maxCells\":1,\"prefer\":false,\"mode\":\"auto\",\"view\":\"POP\"}}}"
content不存在的情况下,仅录制主讲人:"{\"layout\":{\"people\":{\"maxCells\":1,\"mode\":\"auto\",\"view\":\"POP\"}}}
返回结果示例:
{
"meetingId":"xxxxxx",
"meetingRoomNumber":"xxxxxx"
}
返回参数说明
参数 | 说明 |
meetingId | 预约会议id |
meetingRoomNumber | 云会议室号 |
错误码详细见小鱼RESTAPI错误码