编辑企业会议设置
请求方法
PUT
请求地址
/settings
请求参数
MeetingSetting对象定义
参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
enableWaitingRoomForceLock |
Body |
Boolean |
否 |
强管控 是否启用等候室,默认为false |
enableWaitingRoom |
Body |
Boolean |
否 |
是否启用等候室,默认为false |
waitingRoomMode |
Body |
Integer |
否 |
等候室设置,可选值:0=企业内所有人;1=仅主持人;2=企业内所有人及受邀参会者;3=仅受邀参会者,默认为3 |
enableJoinForwardModeratorForceLock |
Body |
Boolean |
否 |
强管控 是否允许在主持人之前加入,默认为false |
enableJoinForwardModerator |
Body |
Boolean |
否 |
允许在主持人之前加入,默认为true |
enableOnlyLoginUserJoinForceLock |
Body |
Boolean |
否 |
强管控 是否启用仅登录用户入会,默认为false |
enableOnlyLoginUserJoin |
Body |
Boolean |
否 |
是否启用仅登录用户入会,默认为false |
enableScreenShareWatermarkForceLock |
Body |
Boolean |
否 |
强管控 是否启用屏幕共享水印,默认为false(已废弃,建议使用enableWatermarkForceLock 参数) |
enableScreenShareWatermark |
Body |
Boolean |
否 |
是否启用屏幕共享水印,默认为false(已废弃,建议使用enableWatermark 参数) |
enableWatermark |
Body |
Boolean |
否 |
是否启用会议水印水印,默认false |
enableWatermarkForceLock |
Body |
Boolean |
否 |
强管控,是否启用会议水印水印,默认false |
watermarkTransparency |
Body |
Integer |
否 |
水印透明度,0:浅;1:中;2:深 |
watermarkFontSize |
Body |
Integer |
否 |
水印文字大小,0:小;1:中;2:大 |
forwardMeetingTime |
Body |
Integer |
否 |
提前入会时间,单位分钟,默认30 |
enableJoinAutoMuteForceLock |
Body |
Boolean |
否 |
强管控 是否启用入会自动静音,默认为false |
enableJoinAutoMute |
Body |
Boolean |
否 |
是否启用入会自动静音,默认为false |
speakMode |
Body |
Integer |
否 |
发言模式,可选值: 0=自由发言;1=申请发言,默认为0 |
attendeesDefaultLayout |
Body |
Integer |
否 |
与会者入会默认布局,可选值:1:演讲者,2:画廊,默认为1 |
voicePromptMode |
Body |
Integer |
否 |
入会/离会提示音模式,可选值:0:无;1:仅入会方接收提示音;2:仅入会方和主持人接收提示音;3:所有参会方接收提示音;默认为1 |
chatPermissionsByAttendees |
Body |
Integer |
否 |
聊天权限-与会者,可选值:0:允许群聊和私聊,1:仅允许群聊,2:仅允许私聊主持人,3:全体成员禁言,默认为0 |
enableChatPermissionsByAudience |
Body |
Boolean |
否 |
是否启用聊天权限-观众,默认为false |
sharePermissions |
Body |
Integer |
否 |
共享权限,可选值:0:所有参会者,1:仅主持人可共享,默认为0 |
annotationPermissions |
Body |
Integer |
否 |
批注权限,可选值:0:所有参会者,1:仅共享者和主持人,默认为0 |
enableRenamePermissionsForceLock |
Body |
Boolean |
否 |
强管控 是否启用改名权限,默认为false |
enableRenamePermissions |
Body |
Boolean |
否 |
是否启用改名权限,默认为true |
enableUnmuteRequiresUserConsentForceLock |
Body |
Boolean |
否 |
强管控 是否启用解除静音需用户同意, 默认为false |
enableUnmuteRequiresUserConsent |
Body |
Boolean |
否 |
是否启用解除静音需用户同意,默认为false |
enableYoutubeLiveStreamingForceLock |
Body |
Boolean |
否 |
强管控 企业Youtube直播推流功能,默认为false |
enableYoutubeLiveStreaming |
Body |
Boolean |
否 |
是否开启Youtube直播推流,默认为false |
rtmpLayout |
Body |
String |
否 |
直播布局,可选值:1:演讲者模式,2:单方全屏模式,默认为1 |
enableCloudRecordingForceLock |
Body |
Boolean |
否 |
强管控 是否启用云端录制,默认为false |
enableCloudRecording |
Body |
Boolean |
否 |
是否启用云端录制,默认为true |
enableAutoRecordForceLock |
Body |
Boolean |
否 |
强管控 是否启用自动录制 |
enableAutoRecord |
Body |
Boolean |
否 |
是否启用自动录制,默认为false |
recordTypeList |
Body |
List<Integer> |
否 |
录制方式,可选值:0:录制视频和音频,1:独立录制辅流,2:独立录制音频,3:录制发言者,必选值:0,默认[0] |
recordResolutionFps |
Body |
String |
否 |
录制最大分辨率,可选值:1080P/30FPS,720P/30FPS,540P/30FPS,360P/30FPS,默认为1080P/30FPS |
enableRecordTimestamp |
Body |
Boolean |
否 |
是否添加时间水印,默认为true |
enableRecordWatermark |
Body |
Boolean |
否 |
是否添加录制水印,默认为true |
recordLayout |
Body |
Integer |
否 |
录制布局,可选值:1:演讲者模式,2:画中画模式,3:等分布局,默认为1 |
enableUniqueParticipantResidenceTime |
Body |
Boolean |
否 |
是否启用唯一与会者超时停留时间,默认false |
uniqueParticipantResidenceTime |
Body |
Integer |
否 |
唯一与会者超时停留时间,单位分钟 |
enableNoModeratorTime |
Body |
Boolean |
否 |
是否启用无主持人停留时间,默认false |
noModeratorTime |
Body |
Integer |
否 |
无主持人停留时间,单位分钟 |
enableForwardMeetingTime |
Body |
Boolean |
否 |
是否开启提前入会时间,默认false |
HTTP状态码
返回值 |
描述 |
200 |
操作成功 |
400 |
客户端传参异常 |
401 |
鉴权失败 |
500 |
服务端异常 |
请求消息示例
PUT /v2/settings HTTP/1.1
Host: api.ylyun.com
Content-Type: application/json
{
"meetingSetting": {
"enableWaitingRoomForceLock": false,
"enableWaitingRoom": false,
"waitingRoomMode": 3,
"enableJoinForwardModeratorForceLock": true,
"enableJoinForwardModerator": true,
"enableOnlyLoginUserJoinForceLock": true,
"enableOnlyLoginUserJoin": false,
"enableScreenShareWatermarkForceLock": false,
"enableScreenShareWatermark": false,
"enableWatermark": false,
"enableWatermarkForceLock": false,
"watermarkTransparency": 1,
"watermarkFontSize": 1,
"forwardMeetingTime": 30,
"enableJoinAutoMuteForceLock": false,
"enableJoinAutoMute": false,
"speakMode": 0,
"attendeesDefaultLayout": 1,
"voicePromptMode": 1,
"chatPermissionsByAttendees": 0,
"enableChatPermissionsByAudience": false,
"sharePermissions": 0,
"annotationPermissions": 0,
"enableRenamePermissionsForceLock": false,
"enableRenamePermissions": false,
"enableUnmuteRequiresUserConsentForceLock": true,
"enableUnmuteRequiresUserConsent": false,
"enableNoModeratorTime": true,
"noModeratorTime": 30,
"enableUniqueParticipantResidenceTime": true,
"uniqueParticipantResidenceTime": 30,
"enableCloudRecordingForceLock": false,
"enableCloudRecording": true,
"enableAutoRecordForceLock": false,
"enableAutoRecord": true,
"recordResolutionFps": "1080P/30FPS",
"recordTypeList": [0],
"enableRecordTimestamp": true,
"enableRecordWatermark": true,
"recordLayout": 1,
"enableYoutubeLiveStreamingForceLock": false,
"enableYoutubeLiveStreaming": false,
"rtmpLayout": 1,
"enableForwardMeetingTime": false
}
}
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
CURL命令示例
curl -XPUT -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' -H "Content-type: application/json" -d '{"enableWaitingRoom": false,"enableWaitingRoomForceLock": false,"waitingRoomMode": 3,"enableJoinForwardModerator": true,"enableJoinForwardModeratorForceLock": true,"enableOnlyLoginUserJoin": false,"enableOnlyLoginUserJoinForceLock": true,"enableWatermark":false,"enableWatermarkForceLock":false,"watermarkTransparency":1,"watermarkFontSize":1,"enableScreenShareWatermark": false,"enableScreenShareWatermarkForceLock": false,"forwardMeetingTime": 30,"enableJoinAutoMute": false,"enableJoinAutoMuteForceLock": false,"speakMode": 0,"attendeesDefaultLayout": 1,"voicePromptMode": 1,"chatPermissionsByAttendees": 0,"enableChatPermissionsByAudience": false,"sharePermissions": 0,"annotationPermissions": 0,"enableRenamePermissions": false,"enableRenamePermissionsForceLock": false,"enableUnmuteRequiresUserConsent": false,"enableUnmuteRequiresUserConsentForceLock": true,"enableNoModeratorTime": true,"noModeratorTime": 30,"enableUniqueParticipantResidenceTime": true,"uniqueParticipantResidenceTime": 30,"enableLocalRecording": true,"enableLocalRecordingForceLock": false,"enableCloudRecording": true,"enableCloudRecordingForceLock": false,"enableAutoRecord": true,"enableAutoRecordForceLock": false,"recordResolutionFps": "1080P/30FPS","recordTypeList": [0],"enableRecordTimestamp": true,"enableRecordWatermark": true,"recordLayout": 1,"enableYoutubeLiveStreaming": false,"enableYoutubeLiveStreamingForceLock": false,"enableForwardMeetingTime": false}' 'https://api.ylyun.com/v2/settings'