云会议室信息修改

功能说明

修改云会议室信息，支持对单一属性、多个属性修改。仅支持sdk类型云会议、企业类型云会议室

默认接口请求频率限制：20次/秒。

实现方法

REST URL

POST https://sdk.xylink.com/api/rest/external/{version}/conference/meetingRoom/property/update?enterpriseId=XXX&meetingRoomNumber=XXX&signature=XXX

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明	初始平台
version	String	Path	是	无	v1	3.9无此接口
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参见签名规则
meetingRoomNumber	String	Query	是	无	会议室号码	5.2 (2024-0329版本） 6.0（2023-1024版本）
displayName	String	Body	否	无	云会议室名称	5.2 (2024-0329版本） 6.0（2023-1024版本）
expireTime	Long	Body	否	无	云会议室过期时间	5.2 (2024-0329版本） 6.0（2023-1024版本）
password	String	Body	否	无	云会议室入会密码	5.2 (2024-0329版本） 6.0（2023-1024版本）
meetingControlPassword	String	Body	否	无	云会议室会议主持密码	5.2 (2024-0329版本） 6.0（2023-1024版本）
autoMute	Integer	Body	否	无	静音模式：0，智能静音（默认第6个人以后自动静音）1,全部静音 2, 不静音	5.2 (2024-0329版本） 6.0（2023-1024版本）
smartMutePerson	Integer	Body	否	无	智能静音人数：从第几个人开始启动智能静音	5.2 (2024-0329版本） 6.0（2023-1024版本）
autoRecord	Boolean	Body	否	无	自动录制开关	5.2 (2024-0329版本） 6.0（2023-1024版本）
hrRecord	Boolean	Body	否	无	高清录制开关	5.2 (2024-0329版本） 6.0（2023-1024版本）
addDeviceName	Boolean	Body	否	无	录制叠加终端名称开关	5.2 (2024-0329版本） 6.0（2023-1024版本）
onlyMainImage	Boolean	Body	否	无	仅录制主会场开关	5.2 (2024-0329版本） 6.0（2023-1024版本）
mediaEncrypt	String	Body	否	无	会议室加密能力：AUTO、AES256、SM4	5.2 (2024-0329版本） 6.0（2023-1024版本）
watermark	Integer	Body	否	无	会议室水印：0 不开启，1 开启会议水印	5.2 (2024-0329版本） 6.0（2023-1024版本）
onlyScheduledCall	Integer	Body	否	无	限制预约呼叫开关： 0，关闭 1，开启	5.2 (2024-0329版本） 6.0（2023-1024版本）
inoutReminder	Boolean	Body	否	无	客户端出入会消息通知开关	5.2 (2024-0329版本） 6.0（2023-1024版本）
pushAudioStream	Boolean	Body	否	无	服务端推流开关	5.2 (2024-0329版本） 6.0（2023-1024版本）
internetCallLimit	Integer	Body	否	无	互联网端呼叫限制 0 不限制 1 限制	公有云 5.2 (2024-0329版本）
enableWaitingRoom	Boolean	Body	否	无	是否开启等候室 false 不开启 true 开启	公有云及分区云20241018
subtitle	Boolean	Body	否	无	是否开启同传字幕 true 开启 false 关闭注：开启同传字幕需要申请企业权限	公有云 5.2 (2024-0329版本）
transcriptionMode	Integer	Body	否	无	会议纪要模式 0 关闭会议纪要 1 开启录制会议纪要模式 2 开始入会会议纪要模式注：开启会议纪要模式需要申请企业权限	公有云 5.2 (2024-0329版本）
generateExtraAudio	boolean	Body	否	无	额外生成音频文件	公有云 5.2 (2024-0329版本）
recordingBitrate	Integer	Body	否	无	码率（取值范围 200-10000，单位为Kbps） 4K--4000~10000、1080P--1000~4000、720P--500~2000、480P--200~1000	公有云 5.2 (2024-0329版本）
recordingResolution	Sring	Body	否	无	分辨率（字符串） 4K、1080P、720P、480P	公有云 5.2 (2024-0329版本）
cascadeBetweenMeeting	boolean	Body	否	false	开启会间级联使能开关 true：使能 false：不使能注：需要配置平台级级联可见性	公有云及分区云20240802
forbidInvitedCascade	boolean	Body	否	false	会间级联禁止被邀请 true：禁止 false：不禁止	公有云及分区云20240802
enableInvitedAutoCascade	boolean	Body	否	false	收到邀请自动级联 true/false	公有云及分区云20240802
crossCloudCallScope	String	Body	否	0	跨云呼叫范围 0：跨云通讯录用户可呼叫1：所有跨云用户禁止呼叫 2：所有跨云用户均可呼叫	公有云及分区云20240802
depCode	String	Body	否	无	部门code，分级分权情况下，如果传值则必须是clientid关联部门或其子部门	公有云

示例代码

请求示例

请求消息体示例（Json）

{
  "displayName": "销售专用会议室"
}

结果示例

请求成功时返回http状态码200

请求失败结果示例

{
    "developerMessage": "ErrorStatus: INVALID_CLOUD_MEETING_NUMBER enterpriseId is INVALID",
    "userMessage": "invalid cloud meeting number",
    "errorCode": 4117,
    "moreInfo": "http://www.com.ainemo.com/errors/4117"
}

错误码

以下仅列出该接口业务逻辑错误码，其他错误码见小鱼RESTAPI错误码

错误码	描述
4117	云会议室号不正确
61012	没有高清录制权限
4001020	参数类型不正确
4001019	云会议室名称不能为空

2025-01-20 19:09:11

导出PDF文档