文档帮助平台
首页服务端API参考 个人信息管理 编辑个人设置
编辑个人设置
更新时间：2025-09-18 01:00:09

编辑个人设置

请求方法

PUT

请求地址

/users/{userId}/settings

请求参数

参数 参数类型 数据类型 是否必需 描述
userId Path String 是 人员Id，长度32
meetingSetting Body MeetingSetting 是 会议设置

HTTP状态码

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

MeetingSetting对象定义

参数 参数类型 数据类型 是否必需 描述
meetNowPasswordCreateType Body Integer 否 即时会议密码生成类型，0：无密码；1：随机密码；2：自定义密码
scheduledPasswordCreateType Body Integer 是 预约会议密码生成类型，0：无密码；1：随机密码；2：自定义密码
meetNowPassword Body String 否 即时会议密码。长度6
scheduledPassword Body String 否 预约会议密码。长度6
enableWaitingRoom Body Boolean 否 是否启用会议等候室，默认为false
waitingRoomMode Body Integer 否 等候室设置，可选值：0=企业内所有人；1=仅主持人；2=企业内所有人及受邀参会者；3=仅受邀参会者，默认为3
enableJoinForwardModerator Body Boolean 否 是否允许在主持人之前加入，默认为true
enableOnlyLoginUserJoin Body Boolean 否 是否启用仅登录用户入会，默认false
enableWatermark Body Boolean 否 是否启用会议水印水印，默认false
watermarkTransparency Body Integer 否 水印透明度，0：浅；1：中；2：深
watermarkFontSize Body Integer 否 水印文字大小，0：小；1：中；2：大
enableScreenShareWatermark Body Boolean 否 是否启用屏幕共享水印，默认false（已废弃，建议使用enableWatermark参数）
forwardMeetingTime Body Integer 是 提前入会时间。范围 5-360
enableJoinAutoMute Body Boolean 是 入会自动静音
speakMode Body Integer 否 发言模式，可选值: 0=自由发言；1=申请发言，默认为0
attendeesDefaultLayout Body Integer 否 与会者入会默认布局，可选值：1：演讲者，2：画廊，默认为1
voicePromptMode Body Integer 是 入会及离会提示音；0：无提示；1：仅入会方接收提示音；2：仅入会方和主持人接收提示音；3：所有参会方接收提示音
chatPermissionsByAttendees Body Integer 否 聊天权限-与会者，可选值：0：允许群聊和私聊，1：仅允许群聊，2：仅允许私聊主持人，3：全体成员禁言，默认为0
sharePermissions Body Integer 否 共享权限，可选值：0：所有参会者，1：仅主持人可共享，默认为0
annotationPermissions Body Integer 否 批注权限，可选值：0：所有参会者，1：仅共享者和主持人，默认为0
enableRenamePermissions Body Boolean 否 是否启用改名权限，默认为true
enableUnmuteRequiresUserConsent Body Boolean 否 是否启用解除静音需用户同意，默认为false
enableYoutubeLiveStreaming Body Boolean 否 是否开启Youtube直播推流，默认为false
rtmpLayout Body Integer 否 网络直播布局，可选值：1：演讲者模式，2：单方全屏，默认为1
enableAutoRecord Body Boolean 否 是否开启自动录制，默认为false
enableCloudRecording Body Boolean 否 是否启用云端录制，默认为true
recordTypeList Body List<Integer> 否 录制方式，可选值：0：录制视频和音频，1：独立录制辅流，2：独立录制音频，3：录制发言者，必选值：0，默认[0]
recordLayout Body Integer 否 录制布局，可选值：1：演讲者模式，2：画中画模式，3：等分布局，默认为1
enableForwardMeetingTime Body Boolean 否 是否开启提前入会时间，默认为false

请求消息示例

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

{
    "meetingSetting": {
        "enableJoinAutoMute": false,
        "voicePromptMode": 1,
        "forwardMeetingTime": 30,
        "meetNowPassword": "123456",
        "scheduledPassword": "123456",
        "meetNowPasswordCreateType": 2,
        "scheduledPasswordCreateType": 2
    }
}

响应消息示例

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 '{"meetingSetting":{"enableJoinAutoMute":false,"voicePromptMode":1,"forwardMeetingTime":30,"meetNowPassword":null,"scheduledPassword":"123456","meetNowPasswordCreateType":0,"scheduledPasswordCreateType":2}}' 'https://api.ylyun.com/v2/users/b4eefd278c444e039dfe81147fab8cc9/settings'
本页目录