简要描述:
修改日程接口,如果修改的是周期会议中的单个日程,原本的整个周期会受到影响。
请求URL:
https://ip/api/v1/umeet/open/schedules/{scheduleId}
请求方式:
PUT
请求参数:
url路径参数.
| Parameters | Type/Value | Require | Description |
|---|---|---|---|
| scheduleId | [string] | 是 | 日程唯一标示 |
请求体参数.
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| topic | [string] | 否 | 日程名称 |
| description | [string] | 否 | 日程描述 |
| startTime | [long] | 否 | 日程开始时间,为null时为立即会议 |
| endTime | [long] | 否 | 日程结束时间 |
| hostLoginName | [string] | 否 | 主持人账号名,如果hostOpenUserId和hostLoginName都传,以hostLoginName为准 |
| hostOpenUserId | [string] | 否 | 通过openApi推送用户里的openUserId字段值,如果hostOpenUserId和hostLoginName都传,以hostLoginName为准 |
| inviteUser | [array] | 否 | 邀请参会人邮箱,最多5000人 |
| emailNotice | [boolean] | 否 | 是否开启邮件通知(true-开启,false-关闭) |
| imNotice | [boolean] | 否 | 是否开启im通知(true-开启,false-关闭) |
| allowChangeNumber | [boolean] | 否 | 是否在资源冲突时换下一个会议号,默认false |
| rooms | [array] | 否 | 关联的会议室id集合 |
| schedulePrivacy | [boolean] | 否 | 是否开启会议隐私 |
| recurrence | [object] | 否 | 周期设置,非周期会议时此参数不传;暂不支持 |
| recurrence.type | [string] | 否 | 重复类型, DAY=按日,WEEK=按周,MONTH=按月 |
| recurrence.frequency | [array] | 否 | 1.按天重复:1=每天, 2=每个工作日;2.按周重复:1=周一,2=周二,3=周三,4=周四,5=周五,6=周六,7=周日(如为腾讯会议,需包含日程开始时间所在周,即如果开始时间是周二,则必须包含2,否则会额外添加); 3.按月重复:length=1时,value表示每月第几日(如为腾讯会议,需选择日程开始时间所在日期,否则会额外添加);length=2时,index0=每月第几个星期,index1=周几(value值同按周重复)(如果为腾讯会议,只支持日程开始时间所在周月,如日程开始时间为第一周周一,则只支持传{1,1},可不传,后台自动计算); |
| recurrence.repeatEndTime | [long] | 否 | 重复周期的结束时间,和repeatTimes只能有一个生效 |
| recurrence.repeatTimes | [int] | 否 | 重复次数,和repeatEndTime只能有一个生效 |
| webMeeting | [object] | 否 | 关联的网络会议,非网络会议时此参数不传 |
| webMeeting.password | [string] | 否 | 会议密码 |
| webMeeting.capacity | [int] | 否 | 会议方数 |
| webMeeting.webinars | [boolean] | 否 | 是否开启网络研讨会功能,开启后等候室和直播将失效,true:开启,默认为false |
| webMeeting.liveFlag | [boolean] | 否 | 是否开启直播功能,true:开启,默认为false |
| webMeeting.waitingRoom | [boolean] | 否 | 是否等候室功能,true:开启,默认为false |
| webMeeting.screenWatermark | [boolean] | 否 | 是否开启屏幕水印功能,true:开启,默认为false |
| webMeeting.usePmi | [boolean] | 否 | 是否使用pmi会议号,修改不可变更参数值 |
| videoMeeting | [object] | 否 | 关联的视频会议,非视频会议时此参数不传 |
| videoMeeting.password | [string] | 否 | 会议密码 |
| videoMeeting.mode | [boolean] | 否 | 会议模式,true 演讲模式; false 讨论模式, 默认为false |
| videoMeeting.mainVenue | [string] | 否 | 主会场,会议室标识,演讲模式时必须设置 |
| videoMeeting.layout | [string] | 否 | 会议分屏, FULL(全屏),AUTO_EQUAL(等分屏),FOUR_MULTIPLY_FOUR(四分屏),ONE_PLUS_SEVEN(1+7),默认为FULL |
| videoMeeting.joinMute | [boolean] | 否 | 新终端入会是否禁音,true 禁音,默认为false |
| videoMeeting.autoCall | [boolean] | 否 | 是否自动呼叫终端,true 自动呼叫终端,默认为false |
| videoMeeting.autoRecording | [boolean] | 否 | 是否开启自动录播,true 自动开启录播,默认为false |
| videoMeeting.autoStreaming | [boolean] | 否 | 是否开启自动直播,true 自动开启直播,默认为false |
| tencentMeeting | [object] | 否 | 关联的腾讯会议,非腾讯会议时此参数不传 |
| tencentMeeting.password | [string] | 否 | 会议密码 |
| tencentMeeting.webinars | [boolean] | 否 | 是否开启网络研讨会功能,true:开启,默认为false |
| tencentMeeting.waitingRoom | [boolean] | 否 | 是否开启等候室功能,true:开启,默认为false |
| tencentMeeting.screenWatermark | [boolean] | 否 | 是否开启屏幕水印功能,true:开启,默认为false |
| tencentMeeting.muteEnableJoin | [boolean] | 否 | 是否开启入会时静音功能,true:开启,默认为true |
| tencentMeeting.muteEnableTypeJoin | [int] | 否 | 入会时静音选项能,0:关闭 1:开启 2:超过6人后自动开启,默认为2 |
| tencentMeeting.autoRecord | [boolean] | 否 | 是否开启自动会议录制功能,true:开启,默认为false |
| tencentMeeting.autoRecordType | [string] | 否 | 自动会议录制类型,none:禁用,表示不开启自动会议录制 local:本地录制,表示主持人入会后自动开启本地录制 cloud:云录制,表示主持人入会后自动开启云录制 |
| tencentMeeting.allowInBeforeHost | [boolean] | 否 | 是否允许成员在主持人进会前加入会议,true:开启,默认为false |
| tencentMeeting.onlyEnterpriseUserAllowed | [boolean] | 否 | 是否仅企业内部成员可入会,true:开启,默认为false |
| tencentMeeting.enableHostKey | [boolean] | 否 | 是否开启主持人密钥,true:开启,默认为false |
| tencentMeeting.hostKey | [string] | 否 | 主持人密钥,仅支持6位数字 |
请求示例:
{
"topic": "string",
"description": "string",
"startTime": "long",
"endTime": "long",
"allowChangeNumber": "boolean",
"rooms": [],
"hostLoginName": "string",
"hostOpenUserId": "string",
"recurrence": {
"type": "string",
"frequency": [],
"repeatEndTime": "long",
"repeatTimes": "integer"
},
"webMeeting": {
"password": "string",
"capacity": "integer",
"webinars": "boolean",
"liveFlag": "boolean",
"waitingRoom": "boolean",
"screenWatermark": "boolean"
},
"videoMeeting": {
"password": "string",
"mode": "boolean",
"mainVenue": "string",
"layout": "string",
"joinMute": "boolean",
"autoCall": "boolean",
"autoRecording": "boolean",
"autoStreaming": "boolean"
},
"tencentMeeting": {
"password": "string",
"webinars": "boolean",
"waitingRoom": "boolean",
"screenWatermark": "boolean",
"muteEnableJoin": "boolean",
"muteEnableTypeJoin": "int",
"autoRecord": "boolean",
"autoRecordType": "string",
"allowInBeforeHost": "boolean",
"onlyEnterpriseUserAllowed": "boolean",
"enableHostKey": "boolean",
"hostKey": "string"
}
}
返回参数说明:
请求成功时,http status code =200,响应体内容如下:
Schedule object.
| Parameters | Type/Value | Description |
|---|---|---|
| data | [string] | id |
请求失败时,http status code = 500,响应体内容如下:
| Parameters | Type/Value | Description |
|---|---|---|
| timestamp | [string] | 错误发生日期 |
| errorCode | [string] | 错误码 |
| message | [string] | 错误信息描述 |