亿联文档帮助中心

查询个人设置详情

请求方法

GET

请求地址

/users/{userId}/settings

请求参数

参数	参数类型	数据类型	是否必需	描述
userId	Path	String	是	人员Id，长度32

HTTP状态码

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

响应参数

参数	数据类型	描述
meetingSetting	MeetingSetting	个人会议配置

MeetingSetting对象定义

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

请求消息示例

GET /open/api/v2/users/7e7e10443f92422ea0d70fa6398a8dd3/settings HTTP/1.1
Host: api.yealink.com
Content-Type: application/json

响应消息示例

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

{
	"meetingSetting": {
		"enableJoinAutoMute": false,
		"voicePromptMode": 1,
		"forwardMeetingTime": 30,
		"meetNowPassword": "",
		"scheduledPassword": "123456",
		"meetNowPasswordCreateType": 0,
		"scheduledPasswordCreateType": 2,
		"enableAutoInvite": false,
		"enableWaitingRoom": false,
		"waitingRoomMode": 3,
		"enableScreenShareWatermark": false,
		"enableWatermark": true,
		"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,
        "waitingRoomModeList": [0,1,2],
        "enableJoinForwardModerator": true

	}
}

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.yealink.com/open/api/v2/users/7e7e10443f92422ea0d70fa6398a8dd3/settings'