文档帮助平台
首页服务端API参考 企业信息管理 查询企业设置详情
查询企业设置详情
更新时间：2025-05-26 14:53:16

查询会议设置详情

请求方法

GET

请求地址

/settings

请求参数

无

HTTP状态码

返回值 描述
200 操作成功，详见响应参数
400 客户端传参异常
401 鉴权失败
500 服务端异常

响应参数

参数 数据类型 描述
meetingSetting MeetingSetting 企业会议配置

MeetingSetting对象定义

参数 数据类型 描述
enableWaitingRoomForceLock Boolean 强管控 是否启用等候室
enableWaitingRoom Boolean 是否启用等候室
waitingRoomMode Integer 等候室设置，可选值：0=企业内所有人；1=仅主持人；2=企业内所有人及受邀参会者；3=仅受邀参会者
enableJoinForwardModeratorForceLock Boolean 强管控 是否允许在主持人之前加入
enableJoinForwardModerator Boolean 允许在主持人之前加入
enableOnlyLoginUserJoinForceLock Boolean 强管控 是否启用仅登录用户入会
enableOnlyLoginUserJoin Boolean 是否启用仅登录用户入会
enableWatermark Boolean 是否启用会议水印
enableWatermarkForceLock Boolean 强管控，是否启用会议水印
watermarkTransparency Integer 水印透明度，0：浅；1：中；2：深
watermarkFontSize Integer 水印文字大小，0：小；1：中；2：大
enableScreenShareWatermark Boolean 是否启用屏幕共享水印（已废弃，建议使用enableWatermark参数）
enableScreenShareWatermarkForceLock Boolean 强管控，是否启用屏幕共享水印（已废弃，建议使用enableWatermarkForceLock参数）
forwardMeetingTime Integer 提前入会时间，单位分钟
enableJoinAutoMuteForceLock Boolean 强管控 是否启用入会自动静音
enableJoinAutoMute Boolean 是否启用入会自动静音
speakMode Integer 发言模式，可选值: 0=自由发言；1=申请发言
attendeesDefaultLayout Integer 与会者入会默认布局，可选值：1：演讲者，2：画廊
voicePromptMode Integer 入会/离会提示音模式，可选值：0：无；1：仅入会方接收提示音；2：仅入会方和主持人接收提示音；3：所有参会方接收提示音
chatPermissionsByAttendees Integer 聊天权限-与会者，可选值：0：允许群聊和私聊，1：仅允许群聊，2：仅允许私聊主持人，3：全体成员禁言
enableChatPermissionsByAudience Boolean 是否启用聊天权限-观众
sharePermissions Integer 共享权限，可选值：0：所有参会者，1：仅主持人可共享
annotationPermissions Integer 批注权限，可选值：0：所有参会者，1：仅共享者和主持人
enableRenamePermissionsForceLock Boolean 强管控 是否启用改名权限
enableRenamePermissions Boolean 是否启用改名权限
enableUnmuteRequiresUserConsentForceLock Boolean 强管控 是否启用解除静音需用户同意
enableUnmuteRequiresUserConsent Boolean 是否启用解除静音需用户同意
enableYoutubeLiveStreamingForceLock Boolean 强管控 企业Youtube直播推流功能
enableYoutubeLiveStreaming Boolean 是否开启Youtube直播推流
rtmpLayout String 直播布局，可选值：1：演讲者模式，2：单方全屏
enableCloudRecordingForceLock Boolean 强管控 是否启用云端录制
enableCloudRecording Boolean 是否启用云端录制
enableAutoRecordForceLock Boolean 强管控 是否启用自动录制
enableAutoRecord Boolean 是否启用自动录制
recordTypeList List<Integer> 录制方式，可选值：0：录制视频和音频，1：独立录制辅流，2：独立录制音频，3：录制发言者
recordResolutionFps String 录制最大分辨率，可选值：1080P/30FPS，720P/30FPS，540P/30FPS，360P/30FPS
enableRecordTimestamp Boolean 是否添加时间水印
enableRecordWatermark Boolean 是否添加录制水印
recordLayout Integer 录制布局，可选值：1：演讲者模式，2：画中画模式，3：等分布局
enableUniqueParticipantResidenceTime Boolean 是否启用唯一与会者超时停留时间
uniqueParticipantResidenceTime Integer 唯一与会者超时停留时间，单位分钟
enableNoModeratorTime Boolean 是否启用无主持人停留时间
noModeratorTime Integer 无主持人停留时间，单位分钟
enableForwardMeetingTime Boolean 是否开启提前入会时间

请求消息示例

GET /v2/settings HTTP/1.1
Host: api.ylyun.com
Content-Type: application/json

响应消息示例

HTTP/1.1 200 
Content-Type: application/json;charset=UTF-8

{
	"meetingSetting": {
		"enableWaitingRoomForceLock": false,
		"enableWaitingRoom": false,
		"waitingRoomMode": 3,
		"enableJoinForwardModeratorForceLock": true,
		"enableJoinForwardModerator": true,
		"enableOnlyLoginUserJoinForceLock": true,
		"enableOnlyLoginUserJoin": false,
		"enableWatermark": false,
		"enableWatermarkForceLock": false,
        "watermarkTransparency": 1,
        "watermarkFontSize": 1,
		"enableScreenShareWatermarkForceLock": false,
		"enableScreenShareWatermark": false,
		"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
	}
}

CURL命令示例

curl -XGET -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' -H 'Content-type: application/json' 'https://api.ylyun.com/v2/settings'
本页目录