文档帮助平台
首页服务端API参考 个人信息管理 编辑个人设置
编辑个人设置
更新时间：2025-05-19 06:37:45

编辑个人设置

请求方法

PUT

请求地址

/users/{userId}/settings

请求参数

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

HTTP状态码

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

MeetingSetting对象定义

参数 参数类型 数据类型 是否必需 描述
enableJoinAutoMute Body Boolean 是 入会自动静音
meetNowPasswordCreateType Body Integer 是 即时会议密码生成类型，0：无密码；1：随机密码；2：自定义密码
scheduledPasswordCreateType Body Integer 是 预约会议密码生成类型，0：无密码；1：随机密码；2：自定义密码
forwardMeetingTime Body Integer 是 提前入会时间，单位：分钟。范围 5-360
meetNowPassword Body String 否 即时会议密码，自定义密码时必填。长度限制1-6位
scheduledPassword Body String 否 预约会议密码，自定义密码时必填。长度限制1-6位
voicePromptMode Body Integer 是 入会及离会提示音；0：无提示；1：仅入会方接收提示音；2：仅入会方和主持人接收提示音；3：所有参会方接收提示音
enableAutoInvite Body Boolean 是 自动呼叫
enableWaitingRoom Body Boolean 是 是否启用会议等候室
~~waitingRoomMode~~ Body Integer 否 已废弃，，支持旧版本兼容,请使用waitingRoomModeList这个字段。会议等候室设置，可选值：0=企业内所有人；1=仅主持人；2=企业内所有人及受邀参会者；3=仅受邀参会者
~~enableScreenShareWatermark~~ Body Boolean 否 已废弃,支持旧版本兼容,请使用enableWatermark字段。是否启用屏幕共享水印,不传则保持旧值 （启用需先开启仅登录用户入会）
enableWatermark Body Boolean 是 是否启用水印,默认为false （启用需先开启仅登录用户入会）
watermarkTransparency Body Integer 是 水印透明度，0：浅；1：中；2：深
watermarkFontSize Body Integer 是 水印文字大小，0：小；1：中；2：大
enableOnlyLoginUserJoin Body Boolean 否 是否启用仅登录用户入会。不传时保持旧值（关闭“仅登录用户入会”时需同步关闭水印）
speakMode Body Integer 否 发言模式；可选值：0=自由发言；1=申请发言。不传时保持旧值
attendeesDefaultLayout Body Integer 否 与会者入会默认布局，可选值：1：演讲者，2：画廊，默认为1。不传时保持旧值
chatPermissionsByAttendees Body Integer 否 聊天权限-与会者，0：允许群聊和私聊，1：仅允许群聊，2：仅允许私聊主持人，3：全体成员禁言。不传时保持旧值
sharePermissions Body Integer 否 共享权限，可选值：0：所有参会者，1：仅主持人可共享，默认为0。不传时保持旧值
annotationPermissions Body Integer 否 批注权限，可选值：0：所有参会者，1：仅共享者和主持人，默认为0。不传时保持旧值
enableRenamePermissions Body Boolean 否 是否启用改名权限。不传时保持旧值
enableUnmuteRequiresUserConsent Body Boolean 否 是否启用解除静音需用户同意。不传时保持旧值
enableOpenVideoRequiresUserConsent Body Boolean 否 是否开启视频需要用户同意。不传时保持旧值
enableChatHistoryExport Body Boolean 否 允许聊天记录导出。不传时保持旧值
enableShowRoomName Body Boolean 否 是否显示会场名称。不传时保持旧值
enableRoomNameStyleCustom Body Boolean 否 是否开启会场名称样式自定义。不传时保持旧值
enableShowRoomStateIcon Body Boolean 否 是否显示会场状态图标。不传时保持旧值
enableAutoRecord Body Boolean 否 是否开启自动录制。不传时保持旧值
recordTypeList Body Integer[] 否 录制方式，可选值：0：录制视频和音频，1：录制独立辅流，2：录制独立音频，3：录制发言者，默认[0]。不传时保持旧值
enableForwardMeetingTime Body Boolean 否 是否开启提前入会时间，默认为false。不传时保持旧值
enableJoinForwardModerator Body Boolean 否 是否允许在主持人之前加入，默认为true。不传时保持旧值
waitingRoomModeList Body Integer[] 否 会议等候室设置（新），可选值：0=开启企业内所有人；1=开启受邀参会者；2=开启第三方入会Ip白名单 启用会议等候室设置时，必填。对于只传递字段waitingRoomMode的场景，已做兼容处理。如果同时传递字段waitingRoomMode和字段waitingRoomModeList，则取字段waitingRoomModeList的值。waitingRoomMode和waitingRoomModeList字段不能同时为空。

请求消息示例

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

{
    "meetingSetting": {
        "enableJoinAutoMute": false,
        "voicePromptMode": 1,
        "forwardMeetingTime": 30,
        "meetNowPassword": "123456",
        "scheduledPassword": "123456",
        "meetNowPasswordCreateType": 2,
        "scheduledPasswordCreateType": 2,
        "enableAutoInvite": false,
        "enableWaitingRoom": false,
        "waitingRoomMode": 3,
        "enableScreenShareWatermark": false,
        "enableWatermark": false,
        "watermarkTransparency": 1, 
        "watermarkFontSize": 1,
        "enableOnlyLoginUserJoin": false,
        "speakMode": 1,
        "attendeesDefaultLayout": 1,
        "chatPermissionsByAttendees": 0,
        "sharePermissions": 0,
        "annotationPermissions": 0,
        "enableRenamePermissions": true,
        "enableUnmuteRequiresUserConsent": false,
        "enableOpenVideoRequiresUserConsent": false,
        "enableChatHistoryExport": true,
        "enableShowRoomName": false,
        "enableRoomNameStyleCustom": true,
        "enableShowRoomStateIcon": false,
        "enableAutoRecord": false,
        "recordTypeList": [
            0
        ],
        "enableForwardMeetingTime": true,
        "enableJoinForwardModerator": true
    }
}

响应消息示例

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,"enableAutoInvite":false,"enableWaitingRoom":false,"waitingRoomMode":3}}' 'https://api.yealink.com/open/api/v2/users/b4eefd278c444e039dfe81147fab8cc9/settings'
本页目录