文档帮助平台
首页服务端API参考 会议管理 编辑会议
编辑会议
更新时间：2025-05-21 07:30:10

编辑会议

请求方法

PUT

请求地址

/users/{userId}/meetings/{meetingId}

请求参数

请求参数 参数类型 数据类型 是否必须 描述
userId Path String 是 用户id，长度32
meetingId Path String 是 会议id，长度32
updateType Body Integer 是 更新类型，可选值：0：更新单个会议，1：更新会议序列
startDate Body String 是 会议开始日期，格式为yyyy-MM-dd，允许当前日期到未来1年内的日期。例：2019-12-01
startTime Body String 是 会议开始时间，格式为HH:mm，小时部分使用24小时计算，分钟部分为5的倍数。会议开始时间必须大于当前时间。例：19:05
subject Body String 是 会议主题，长度小于128
sequence Body Long 否 会议顺序号，取值范围为[1, 100]，更新单个会议时必输
zoneId Body String 是 时区ID。具体时区列表信息详见基础信息-查询时区列表接口
durationHour Body Integer 是 会议持续时间小时部分，取值范围为[0, 48)。
durationMinute Body Integer 是 会议持续时间分钟部分，当durationHour为0时，可选值为：30、45；其他情况下，可选值为：0、15、30、45。
recurrenceType Body Integer 否 周期会议循环类型，取值范围为：0：按天循环，1：按周循环，2：按月的第X天循环。此项没有值表示单次会议。更新会议序列时必输。 注意：直播类型的会议不能预约为周期会议。当原会议为周期会议，而更新时数据为空时，将设置为单次会议。
interval Body Integer 否 时间间隔，当recurrenceType为0和1时必输。
当recurrenceType为0时，取值范围为[1, 365]。
当recurrenceType为1时，取值范围为[1, 52]。
例：当recurrenceType为0时，interval = 2，表示每隔2天进行一个会议。
dayOfWeeks Body String[] 否 每周的周几，当recurrenceType为1时必输。取值范围为：1：星期日，2：星期一，3：星期二，4：星期三，5：星期四，6：星期五，7：星期六
rangeEndDate Body String 否 循环结束日期，格式为yyyy-MM-dd，当recurrenceType有值时必输。循环结束日期必须大于会议开始日期。最大可以选择1年以内的日期
remark Body String 否 备注，最大长度为300。若为空则数据更新为空字符。
participants Body Participant[] 否 参会成员列表。参会成员数量默认支持100个，如需调整请联系亿联会议，若为空则数据更新为组织者
enableAutoRecord Body Boolean 否 是否开启自动录制，若为空则数据更新为个人信息-高级设置中的自动录制设置
meetingPassword Body String 否 会议密码，格式为：6位数字
enableWaitingRoom Body Boolean 否 是否开启等候室
waitingRoomMode Body Integer 否 等候室模式，enableWaitingRoom为true时必输。取值范围为：0：企业内所有人，2：仅主持人，3：企业内所有人及受邀参会者，4：仅受邀参会者
enableJoinForwardModerator Body Boolean 否 是否开启允许在主持人之前入会
enableJoinAutoMute Body Boolean 否 是否开启入会自动静音
speakMode Body Integer 否 发言模式。取值范围为：0：自由发言，1：举手发言
enableWatermark Body Boolean 否 是否启用会议水印水印，默认false
watermarkTransparency Body Integer 否 水印透明度，0：浅；1：中；2：深
watermarkFontSize Body Integer 否 水印文字大小，0：小；1：中；2：大
enableScreenShareWatermark Body Boolean 否 是否启用屏幕共享水印，默认false（已废弃，建议使用enableWatermark参数）
enableOnlyLoginUserJoin Body Boolean 否 是否开启仅登录用户才能入会
rtmpWatchPwd Body String 否 rtmp直播观看密码，格式为：4位数字或字母
rtmpRichTextRemark Body String 否 直播介绍，长度小于3000

HTTP状态码

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

Participant对象定义

参数 参数类型 数据类型 是否必需 描述
id Body String 是 参会者id，长度小于64，若为外部参会者，可以为邮箱地址
role Body Integer 是 参会者类型，0：组织者；1：主持人；2：参会者；3：观众。
type Body Integer 否 参会者类型，0：内部参会者；1：外部参会者。默认：0

请求消息示例

PUT /v2/users/3637ad2cc6d040aeaf27f78d8c8826db/meetings/97575840aeeb49a5b5deeddd5595f9f4 HTTP/1.1
Host: api.ylyun.com
Content-Type: application/json

{
    "subject": "test的会议测试编辑",
    "zoneId": "China_Standard_Time",
    "updateType": 0,
    "startDate": "2020-03-11",
    "startTime": "17:50",
    "sequence": 1,
    "durationHour": 0,
    "durationMinute": 30,
    "recurrenceType": 0,
    "interval": 1,
    "dayOfWeeks": [
        3
    ],
    "rangeEndDate": "2020-03-14",
    "remark": "",
    "participants": [
        {
            "id": "3637ad2cc6d040aeaf27f78d8c8826db",
            "type": 0,
            "role": 0
        }
    ],
    "enableAutoRecord": false,
    "meetingPassword": "123456",
    "enableWaitingRoom": true,
    "waitingRoomMode": 0,
    "enableJoinForwardModerator": true,
    "enableJoinAutoMute": true,
    "speakMode": 0,
    "enableWatermark": true,
    "watermarkTransparency": 1,
    "watermarkFontSize": 1,
    "enableScreenShareWatermark": true,
    "enableOnlyLoginUserJoin": true,
    "rtmpWatchPwd": "1knm",
    "rtmpRichTextRemark": "直播介绍"
}

响应消息示例

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 'Content-Type: application/json' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' -d '{"subject":"test的会议测试编辑","zoneId":"China_Standard_Time","updateType":0,"startDate":"2020-03-11","startTime":"17:50","sequence":1,"durationHour":0,"durationMinute":30,"recurrenceType":0,"interval":1,"dayOfWeeks":[3],"rangeEndDate":"2020-03-14","remark":"","participants":[{"id":"3637ad2cc6d040aeaf27f78d8c8826db","type":0,"role":0}],"enableAutoRecord":false,"meetingPassword":"123456","enableWaitingRoom":true,"waitingRoomMode":1,"enableJoinForwardModerator":true,"enableJoinAutoMute":true,"speakMode": 1,"enableWatermark":true,"watermarkTransparency":1,"watermarkFontSize":1,"enableScreenShareWatermark":true,"enableOnlyLoginUserJoin":true,"rtmpWatchPwd":"1cnw","rtmpRichTextRemark":"<p>openApi创建</p>"}}' 'https://api.ylyun.com/v2/users/3637ad2cc6d040aeaf27f78d8c8826db/meetings/97575840aeeb49a5b5deeddd5595f9f4'
本页目录